pyu-activesp 0.0.4.1.2

data/lib/activesp/content_type.rb

@@ -0,0 +1,152 @@
+# Copyright (c) 2010 XAOP bvba
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# 
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# 
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+module ActiveSP
+  
+  class ContentType < Base
+    
+    include InSite
+    extend Caching
+    extend PersistentCaching
+    include Util
+    
+    # @private
+    attr_reader :id
+    
+    persistent { |site, list, id, *a| [site.connection, [:content_type, id]] }
+    # @private
+    def initialize(site, list, id, name = nil, description = nil, version = nil, group = nil)
+      @site, @list, @id = site, list, id
+      @Name = name if name
+      @Description = description if description
+      @Version = version if version
+      @Group = group if group
+    end
+    
+    # Returns the scope of the content type. This can be either a site or a list
+    # @return [Site, List]
+    def scope
+      @list || @site
+    end
+    
+    # Returns the supertype of this content type. This is the content type as defined on the containing
+    # site in case this content type has a list as scope. returns nil for a content type that has a site
+    # as scope
+    # @return [ContentType, nil]
+    def supertype
+      superkey = split_id[0..-2].join("")
+      (@list ? @list.content_type(superkey) : nil) || @site.content_type(superkey)
+    end
+    cache :supertype
+    
+    # See {Base#key}
+    # @return [String]
+    def key
+      encode_key("T", [scope.key, @id])
+    end
+    
+    # @private
+    def Name
+      data["Name"].to_s
+    end
+    cache :Name
+    
+    # @private
+    def Description
+      data["Description"].to_s
+    end
+    cache :Description
+    
+    # @private
+    def Version
+      data["Version"].to_s
+    end
+    cache :Version
+    
+    # @private
+    def Group
+      data["Group"].to_s
+    end
+    cache :Group
+    
+    # Returns the list of fields defined for this content type
+    # @return [Array<Field>]
+    def fields
+      data.xpath("//sp:Field", NS).map { |field| scope.field(field["ID"]) }.compact
+    end
+    cache :fields, :dup => :always
+    
+    # See {Base#save}
+    # @return [void]
+    def save
+      p untype_cast_attributes(@site, nil, internal_attribute_types, changed_attributes)
+    end
+    
+    # @private
+    def to_s
+      "#<ActiveSP::ContentType Name=#{self.Name}>"
+    end
+    
+    # @private
+    alias inspect to_s
+    
+  private
+    
+    def data
+      if @list
+        call("Lists", "get_list_content_type", "listName" => @list.id, "contentTypeId" => @id).xpath("//sp:ContentType", NS).first
+      else
+        call("Webs", "get_content_type", "contentTypeId" => @id).xpath("//sp:ContentType", NS).first
+      end
+    end
+    cache :data
+    
+    def original_attributes
+      type_cast_attributes(@site, nil, internal_attribute_types, clean_item_attributes(data.attributes))
+    end
+    cache :original_attributes
+    
+    def internal_attribute_types
+      @@internal_attribute_types ||= {
+        "Description" => GhostField.new("ColName", "Text", false, true),
+        "FeatureId" => GhostField.new("ColName", "Text", false, true),
+        "Group" => GhostField.new("ColName", "Text", false, true),
+        "Hidden" => GhostField.new("Hidden", "Bool", false, true),
+        "ID" => GhostField.new("ColName", "Text", false, true),
+        "Name" => GhostField.new("ColName", "Text", false, true),
+        "ReadOnly" => GhostField.new("ReadOnly", "Bool", false, true),
+        "Sealed" => GhostField.new("Sealed", "Bool", false, true),
+        "V2ListTemplateName" => GhostField.new("V2ListTemplateName", "Text", false, true),
+        "Version" => GhostField.new("Version", "Integer", false, true)
+      }
+    end
+    
+    def split_id
+      ["0x"] + @id[2..-1].scan(/[0-9A-F][1-9A-F]|[1-9A-F][0-9A-F]|00[0-9A-F]{32}/)
+    end
+    
+  end
+  
+end

data/lib/activesp/field.rb

@@ -0,0 +1,193 @@
+# Copyright (c) 2010 XAOP bvba
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# 
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# 
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+module ActiveSP
+  
+  class Field < Base
+    
+    include InSite
+    extend Caching
+    include Util
+    
+    # @private
+    attr_reader :ID, :Name, :internal_type
+    # Returns the scope of the field. This can be a site or a list
+    # @return [Site, List]
+    attr_reader :scope
+    # Returns the parent field. This is the field defined on the containing site in case the field has a list as scope
+    # @return [Field]
+    attr_reader :parent
+    
+    # There is no call to get to the field info directly, so these should always
+    # be accessed through the site or list they belong to. Hence, we do not use
+    # caching here as it is useless.
+    # @private
+    def initialize(scope, id, name, type, parent, attributes_before_type_cast)
+      @scope, @ID, @Name, @internal_type, @parent, @attributes_before_type_cast = scope, id, name, type, parent, attributes_before_type_cast
+      @site = Site === @scope ? @scope : @scope.site
+    end
+    
+    # See {Base#key}
+    # @return [String]
+    def key
+      encode_key("A", [@scope.key, @ID])
+    end
+    
+    # @private
+    def List
+      list_for_lookup
+    end
+    
+    # @private
+    def Type
+      translate_internal_type(self)
+    end
+    
+    # @private
+    def Mult
+      !!attributes["Mult"]
+    end
+    
+    # @private
+    def ReadOnly
+      !!attributes["ReadOnly"]
+    end
+    
+    # See {Base#save}
+    # @return [void]
+    def save
+      p untype_cast_attributes(@site, nil, internal_attribute_types, changed_attributes)
+    end
+    
+    # @private
+    def to_s
+      "#<ActiveSP::Field name=#{self.Name}>"
+    end
+    
+    # @private
+    alias inspect to_s
+    
+  private
+    
+    def list_for_lookup
+      # I think List may be undefined for attributes defined at the site level, and that they need to be specified
+      # when used at the list level.
+      if %w[Lookup LookupMulti].include?(@internal_type) and list = @attributes_before_type_cast["List"]
+        if list[0] == ?{ && list[-1] == ?} # We have a GUID of a list
+          ActiveSP::List.new(@site, list)
+        elsif list == "Self"
+          List === @scope ? @scope : nil
+        end
+      end
+    end
+  
+    def original_attributes
+      @original_attributes ||= type_cast_attributes(@site, nil, internal_attribute_types, @attributes_before_type_cast.merge("List" => list_for_lookup, "Type" => self.Type, "internal_type" => internal_type))
+    end
+    
+    def internal_attribute_types
+      @@internal_attribute_types ||= {
+        "AllowDeletion" => GhostField.new("AllowDeletion", "Bool", false, true),
+        "AppendOnly" => GhostField.new("AppendOnly", "Bool", false, true),
+        "AuthoringInfo" => GhostField.new("AuthoringInfo", "Text", false, true),
+        "CalType" => GhostField.new("CalType", "Integer", false, true),
+        "CanToggleHidden" => GhostField.new("CanToggleHidden", "Bool", false, true),
+        "ClassInfo" => GhostField.new("ClassInfo", "Text", false, true),
+        "ColName" => GhostField.new("ColName", "Text", false, true),
+        "Description" => GhostField.new("Description", "Text", false, true),
+        "Dir" => GhostField.new("Dir", "Text", false, true),
+        "DisplaceOnUpgrade" => GhostField.new("DisplaceOnUpgrade", "Bool", false, true),
+        "DisplayImage" => GhostField.new("DisplayImage", "Text", false, true),
+        "DisplayName" => GhostField.new("DisplayName", "Text", false, true),
+        "DisplayNameSrcField" => GhostField.new("DisplayNameSrcField", "Text", false, true),
+        "DisplaySize" => GhostField.new("DisplaySize", "Integer", false, true),
+        "ExceptionImage" => GhostField.new("ExceptionImage", "Text", false, true),
+        "FieldRef" => GhostField.new("FieldRef", "Text", false, true),
+        "FillInChoice" => GhostField.new("FillInChoice", "Bool", false, true),
+        "Filterable" => GhostField.new("Filterable", "Bool", false, true),
+        "Format" => GhostField.new("Format", "Bool", false, true),
+        "FromBaseType" => GhostField.new("FromBaseType", "Bool", false, true),
+        "Group" => GhostField.new("Group", "Text", false, true),
+        "HeaderImage" => GhostField.new("HeaderImage", "Text", false, true),
+        "Height" => GhostField.new("Height", "Integer", false, true),
+        "Hidden" => GhostField.new("Hidden", "Bool", false, true),
+        "ID" => GhostField.new("ID", "Text", false, true),
+        "IMEMode" => GhostField.new("IMEMode", "Text", false, true),
+        "internal_type" => GhostField.new("internal_type", "Text", false, true),
+        "IsolateStyles" => GhostField.new("IsolateStyles", "Bool", false, true),
+        "JoinColName" => GhostField.new("JoinColName", "Text", false, true),
+        "JoinRowOrdinal" => GhostField.new("JoinRowOrdinal", "Integer", false, true),
+        "JoinType" => GhostField.new("JoinType", "Text", false, true),
+        "List" => GhostField.new("List", "ListReference", false, true),
+        "Max" => GhostField.new("Max", "Integer", false, true),
+        "MaxLength" => GhostField.new("MaxLength", "Integer", false, true),
+        "Min" => GhostField.new("Min", "Integer", false, true),
+        "Mult" => GhostField.new("Mult", "Bool", false, true),
+        "Name" => GhostField.new("Name", "Text", false, true),
+        "Node" => GhostField.new("Node", "Text", false, true),
+        "NoEditFormBreak" => GhostField.new("NoEditFormBreak", "Bool", false, true),
+        "NumLines" => GhostField.new("NumLines", "Text", false, true),
+        "Percentage" => GhostField.new("Percentage", "Bool", false, true),
+        "PIAttribute" => GhostField.new("PIAttribute", "Text", false, true),
+        "PITarget" => GhostField.new("PITarget", "Text", false, true),
+        "PrependId" => GhostField.new("PrependId", "Bool", false, true),
+        "PrimaryKey" => GhostField.new("PrimaryKey", "Bool", false, true),
+        "PrimaryPIAttribute" => GhostField.new("PrimaryPIAttribute", "Text", false, true),
+        "PrimaryPITarget" => GhostField.new("PrimaryPITarget", "Text", false, true),
+        "ReadOnly" => GhostField.new("ReadOnly", "Bool", false, true),
+        "ReadOnlyEnforced" => GhostField.new("ReadOnlyEnforced", "Bool", false, true),
+        "RenderXMLUsingPattern" => GhostField.new("ReadOnly", "Bool", false, true),
+        "Required" => GhostField.new("Required", "Bool", false, true),
+        "RestrictedMode" => GhostField.new("RestrictedMode", "Bool", false, true),
+        "RichText" => GhostField.new("RichText", "Bool", false, true),
+        "RichTextMode" => GhostField.new("RichTextMode", "Text", false, true),
+        "RowOrdinal" => GhostField.new("RowOrdinal", "Integer", false, true),
+        "Sealed" => GhostField.new("Sealed", "Bool", false, true),
+        "ShowInDisplayForm" => GhostField.new("ShowInDisplayForm", "Bool", false, true),
+        "ShowInListSettings" => GhostField.new("ShowInListSettings", "Bool", false, true),
+        "ShowInFileDlg" => GhostField.new("ShowInFileDlg", "Bool", false, true),
+        "ShowInVersionHistory" => GhostField.new("ShowInVersionHistory", "Bool", false, true),
+        "Sortable" => GhostField.new("Sortable", "Bool", false, true),
+        "SourceID" => GhostField.new("SourceID", "Text", false, true),
+        "StaticName" => GhostField.new("StaticName", "Text", false, true),
+        "StorageTZ" => GhostField.new("StorageTZ", "Bool", false, true),
+        "TextOnly" => GhostField.new("TextOnly", "Bool", false, true),
+        "Title" => GhostField.new("Title", "Text", false, true),
+        "Type" => GhostField.new("Type", "Text", false, true),
+        "SetAs" => GhostField.new("SetAs", "Text", false, true),
+        "ShowField" => GhostField.new("ShowField", "Text", false, true),
+        "ShowInEditForm" => GhostField.new("ShowInEditForm", "Bool", false, true),
+        "ShowInNewForm" => GhostField.new("ShowInNewForm", "Bool", false, true),
+        "UnlimitedLengthInDocumentLibrary" => GhostField.new("UnlimitedLengthInDocumentLibrary", "Bool", false, true),
+        "Version" => GhostField.new("Version", "Integer", false, true),
+        "Width" => GhostField.new("Width", "Integer", false, true),
+        "WikiLinking" => GhostField.new("WikiLinking", "Bool", false, true),
+        "XName" => GhostField.new("XName", "Text", false, true)
+      }
+    end
+    
+  end
+  
+end

data/lib/activesp/file.rb

@@ -0,0 +1,71 @@
+# Copyright (c) 2010 XAOP bvba
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# 
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# 
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+module ActiveSP
+  
+  class File
+    
+    include InSite
+    
+    attr_reader :url
+    
+    def initialize(item, url, destroyable)
+      @item, @url, @destroyable = item, url, destroyable
+      @site = @item.list.site
+    end
+    
+    def file_name
+      ::File.basename(@url)
+    end
+    
+    def data
+      @item.list.site.connection.fetch(@url).body
+    end
+    
+    def destroy
+      if @destroyable
+        result = call("Lists", "delete_attachment", "listName" => @item.list.id, "listItemID" => @item.ID, "url" => @url)
+        if delete_result = result.xpath("//sp:DeleteAttachmentResponse", NS).first
+          self
+        else
+          raise "file could not be deleted"
+        end
+      else
+        raise TypeError, "this file cannot be destroyed"
+      end
+    end
+    
+    # @private
+    def to_s
+      "#<ActiveSP::File url=#{@url}>"
+    end
+    
+    # @private
+    alias inspect to_s
+    
+  end
+  
+end
+

data/lib/activesp/folder.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2010 XAOP bvba
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# 
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# 
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+module ActiveSP
+  
+  class Folder < Item
+    
+    # See {Base#key}
+    # @return [String]
+    def key
+      encode_key("F", [@list.key, @id])
+    end
+    
+    def is_folder?
+      false
+    end
+    
+    # Returns the list of items in this folder
+    # @param [Hash] options See {List#each_item}, :folder option has no effect
+    # @return [Array<Item>]
+    def each_item(options = {}, &blk)
+      @list.each_item(options.merge(:folder => self), &blk)
+    end
+    association :items
+    
+    def each_folder(options = {}, &blk)
+      @list.each_folder(options.merge(:folder => self), &blk)
+    end
+    association :folders do
+      def create(parameters = {})
+        @object.create_folder(parameters)
+      end
+    end
+    
+    def create_folder(parameters = {})
+      @list.create_folder(parameters.merge(:folder => absolute_url))
+    end
+    
+    def each_document(options = {}, &blk)
+      @list.each_document(options.merge(:folder => self), &blk)
+    end
+    association :documents do
+      def create(parameters = {})
+        @object.create_document(parameters)
+      end
+    end
+    
+    def create_document(parameters = {})
+      @list.create_document(parameters.merge(:folder => absolute_url))
+    end
+    
+    # Returns the item with the given name
+    # @param [String] name
+    # @return [Item]
+    def item(name)
+      query = Builder::XmlMarkup.new.Query do |xml|
+        xml.Where do |xml|
+          xml.Eq do |xml|
+            xml.FieldRef(:Name => "FileLeafRef")
+            xml.Value(name, :Type => "Text")
+          end
+        end
+      end
+      items(:query => query).first
+    end
+    
+    alias / item
+    
+    undef content
+    
+    # @private
+    def to_s
+      "#<ActiveSP::Folder url=#{url}>"
+    end
+    
+    # @private
+    alias inspect to_s
+    
+  end
+  
+end

data/lib/activesp/ghost_field.rb

@@ -0,0 +1,100 @@
+# Copyright (c) 2010 XAOP bvba
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# 
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# 
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+module ActiveSP
+  
+  # This class represents the field definitions for objects in SharePoint for which the
+  # fields cannot be changed and are thus not represented by an object in SharePoint.
+  # These include fields of sites, lists, users, grouos, roles, content types and fields.
+  # The interface of this class is not as complete as the interface if a Field, mainly
+  # because it does not make much sense to do so
+  class GhostField
+    
+    include Util
+    
+    # @private
+    attr_reader :Name, :internal_type, :Mult, :ReadOnly
+    
+    # @private
+    def initialize(name, type, mult, read_only)
+      @Name, @internal_type, @Mult, @ReadOnly = name, type, mult, read_only
+    end
+    
+    # @private
+    def Type
+      translate_internal_type(self)
+    end
+    
+    # Returns the attributes of this object as a Hash
+    # @return [Hash{String => Integer, Float, String, Time, Boolean, Base}]
+    def attributes
+      original_attributes.dup
+    end
+    
+    # Returns the value of the attribute of the given name, or nil if this object does not have an attribute by the given name
+    # @param [String] name The name of the attribute
+    # @return [Integer, Float, String, Time, Boolean, Base]
+    def attribute(name)
+      current_attributes[name]
+    end
+    
+    # Returns whether or not this object has an attribute with the given name
+    # @param [String] name The name of the attribute
+    # @return [Boolean]
+    def has_attribute?(name)
+      current_attributes.has_key?(name)
+    end
+    
+    # See {Base#method_missing}
+    def method_missing(m, *a, &b)
+      ms = m.to_s
+      if a.length == 0 && has_attribute?(ms)
+        attribute(ms)
+      else
+        super
+      end
+    end
+    
+  private
+    
+    def current_attributes
+      original_attributes
+    end
+    
+    def original_attributes
+      @original_attributes ||= {
+        "ColName" => @Name,
+        "DisplayName" => @Name,
+        "Mult" => @Mult,
+        "Name" => @Name,
+        "ReadOnly" => @ReadOnly,
+        "StaticName" => @Name,
+        "Type" => self.Type
+      }
+    end
+    
+  end
+  
+end