notesgrip 0.0.4

data/lib/notesgrip/NotesDocument.rb

@@ -0,0 +1,258 @@
+module Notesgrip
+  # ====================================================
+  # ============= NotesDocument Class ================
+  # ====================================================
+  class NotesDocument < GripWrapper
+    def initialize(raw_doc)
+      super(raw_doc)
+      @parent_db = nil
+      @parent_view = nil
+    end
+    
+    def EmbeddedObjects
+      raw_embeddedObjects = @raw_object.EmbeddedObjects
+      ret_list = []
+      raw_embeddedObjects.each {|raw_embeddedObject|
+        ret_list.push NotesEmbeddedObject.new(raw_embeddedObject)
+      }
+      ret_list
+    end
+    
+    def Items
+      ret_list = []
+      @raw_object.Items.each {|raw_item|
+        if raw_item.Type == NotesItem::RICHTEXT
+          ret_list.push NotesRichTextItem.new(raw_item)
+        else
+          ret_list.push NotesItem.new(raw_item)
+        end
+      }
+      ret_list
+    end
+    
+    def ParentDatabase
+      NotesDatabase.new(@raw_object.ParentDatabase)
+    end
+    
+    def ParentView
+      raw_view = @raw_object.ParentView
+      raw_view ? NotesView(raw_view) : nil
+    end
+    
+    def Responses
+      raw_docCollection = @raw_object.Responses
+      NotesDocumentCollection.new(raw_docCollection)
+    end
+    
+    def AppendItemValue( itemName, value )
+      raw_item = @raw_object.AppendItemValue( itemName, value )
+      NotesItem.new(raw_item)
+    end
+    
+    def AttachVCard( clientADTObject )
+      raw_obj = toRaw(clientADTObject)
+      @raw_object.AttachVCard(raw_obj)
+    end
+    
+    def CopyAllItems( sourceDoc, replace=false )
+      raw_sourceDoc = toRaw(sourceDoc)
+      @raw_object.CopyAllItems( raw_sourceDoc, replace)
+    end
+    
+    def CopyItem( sourceItem, newName=nil )
+      raw_sourceItem = toRaw(sourceItem)
+      unless newName
+        newName = sourceItem.Name
+      end
+      raw_item = @raw_object.CopyItem(raw_sourceItem, newName)
+      NotesItem.new(raw_item)
+    end
+    
+    def CopyToDatabase( destDatabase )
+      raw_destDB = toRaw(destDatabase)
+      new_rawDoc = @raw_object.CopyToDatabase( raw_destDB )
+      NotesDocument.new(new_rawDoc)
+    end
+    
+    def CreateMIMEEntity( itemName )
+      raw_mimeEntry = @raw_object.CreateMIMEEntity( itemName )
+      NotesMIMEEntity.new(raw_mimeEntry)
+    end
+    
+    def CreateReplyMessage( all )
+      raw_replyDoc = @raw_object.CreateReplyMessage( all )
+      NotesDocument.new(raw_replyDoc)
+    end
+    
+    def CreateRichTextItem( name )
+      raw_richTextItem = @raw_object.CreateRichTextItem( name )
+      NotesRichTextItem.new(raw_richTextItem)
+    end
+    
+    def GetAttachment( fileName )
+      raw_embeddedObject = @raw_object.GetAttachment( fileName )
+      raw_embeddedObject ? NotesEmbeddedObject.new(raw_embeddedObject) : nil
+    end
+    
+    def GetFirstItem( name )
+      raw_item = @raw_object.GetFirstItem( name )
+      raw_item ? NotesItem.new(raw_item) : nil
+    end
+    
+    def GetItemValue( itemName )
+      @raw_object.GetItemValue( itemName )
+    end
+    
+    def GetItemValueCustomDataBytes( itemName, dataTypeName )
+      @raw_object.GetItemValueCustomDataBytes( itemName, dataTypeName )
+    end
+    
+    def GetItemValueDateTimeArray( itemName )
+      obj_list = @raw_object.GetItemValueDateTimeArray( itemName )
+      ret_list = []
+      obj_list.each {|date_obj|
+        ret_list.push NotesDateTime.new(date_obj)
+      }
+    end
+    
+    def GetMIMEEntity( itemName )
+      raw_mimeEntry = @raw_object.GetMIMEEntity( itemName )
+      raw_mimeEntry ? NotesMIMEEntity.new(raw_mimeEntry) : nil
+    end
+    
+    def MakeResponse( document )
+      NotesDocument.new(toRaw(document))
+    end
+    
+    def RenderToRTItem( notesRichTextItem )
+      raw_richTextItem = toRaw(notesRichTextItem)
+      @raw_object.RenderToRTItem(raw_richTextItem)
+    end
+    
+    def ReplaceItemValue( itemName, value )
+      raw_item = @raw_object.ReplaceItemValue( itemName, value )
+      NotesItem.new(raw_item)      
+    end
+    
+    def ReplaceItemValueCustomDataBytes( itemName, dataTypeName, byteArray )
+      @raw_object.ReplaceItemValueCustomDataBytes( itemName, dataTypeName, byteArray )
+    end
+    
+    # ---- Additional Methods ------
+    def unid
+      @raw_object.UniversalID
+    end
+    
+    def [](itemname)
+      if @raw_object.HasItem(itemname)
+        raw_item = @raw_object.GetFirstItem(itemname)
+      else
+        # If this document hasn't itemname field, create new item.
+        raw_item = @raw_object.AppendItemValue(itemname, "")
+      end
+      if raw_item.Type == NotesItem::RICHTEXT
+        NotesRichTextItem.new(raw_item)
+      else
+        NotesItem.new(raw_item)
+      end
+    end
+    
+    # Copy Field
+    def []=(itemname, other_item)
+      if @raw_object.HasItem(itemname)
+        @raw_object.RemoveItem(itemname) # �����̃f�[�^����������Ԃ�CopyItem���ĂԂƁA�lj������ɂȂ�̂�
+      end
+      
+      raw_otherItem = toRaw(other_item)
+      raw_item = @raw_object.CopyItem(raw_otherItem, itemname)
+      NotesItem.new(raw_item)
+    end
+    
+    def each_item
+      self.Items.each {|notes_item|
+        yield notes_item
+      }
+    end
+    
+    def save(force=true, createResponse=false , markRead = false)
+      @raw_object.Save(force, createResponse, markRead)
+    end
+    
+    def inspect
+      "<#{self.class}, Form:#{self['Form'].text.inspect}>"
+    end
+    
+  end
+
+  # ====================================================
+  # ====== NotesDocumentCollection Class ===============
+  # ====================================================
+  class NotesDocumentCollection < GripWrapper
+    include DocCollection
+    
+    def Count
+      @raw_object.count
+    end
+    alias size Count
+    
+    def Parent
+      NotesDatabase.new(@raw_object.Parent)
+    end
+    
+    def AddDocument( document)
+      raw_doc = toRaw(document)
+      @raw_object.AddDocument(raw_doc)
+    end
+    
+    def Clone()
+       NotesDocumentCollection.new(@raw_object.Clone())
+    end
+    
+    def Contains( inputNotes )
+      raw_obj = toRaw(inputNotes)
+      @raw_object.Contains(raw_obj)
+    end
+    
+    def DeleteDocument( document )
+      raw_doc = toRaw(document)
+      @raw_object.DeleteDocument(raw_doc)
+    end
+    
+    def FTSearch( query, maxDocs )
+      raw_docCollection = @raw_object.FTSearch( query, maxDocs )
+      FTSearch( raw_docCollection )
+    end
+    
+    def GetDocument( document )
+      raw_doc = toRaw(document)
+      raw_doc2 = @raw_object.GetDocument(raw_doc)
+      raw_doc2 ? NotesDocument.new(raw_doc2) : nil
+    end
+    
+    def Intersect( inputNotes )
+      raw_obj = toRaw(inputNotes)
+      @raw_object.Intersect(raw_obj)
+    end
+    
+    def Merge( inputNotes )
+      raw_obj = toRaw(inputNotes)
+      @raw_object.Merge(raw_obj)
+    end
+    
+    def StampAllMulti( document )
+      raw_doc = toRaw(document)
+      @raw_object.StampAllMulti(raw_doc)
+    end
+    
+    def Subtract( inputNotes )
+      raw_obj = toRaw(inputNotes)
+      @raw_object.Subtract(raw_obj)
+    end
+    
+    # ---- Additional Methods ------
+    def inspect
+      "<#{self.class}, Count:#{self.Count}>"
+    end
+  end
+
+end

data/lib/notesgrip/NotesItem.rb

@@ -0,0 +1,172 @@
+module Notesgrip
+  # ====================================================
+  # ================= NotesItem Class ==================
+  # ====================================================
+  class NotesItem < GripWrapper
+    class NameError < StandardError
+    end
+    class RichFieldError < StandardError
+    end
+    
+    RICH_TYP = 1
+    DATE_TYP = 1024
+    ATTACHMENT_TYP = 1084
+    TEXT_TYP = 1280
+    NAME_TYP = 1074
+    
+    def DateTimeValue
+      raw_dateTimeVal = @raw_object.DateTimeValue
+      raw_dateTimeVal ? NotesDateTime.new(raw_dateTimeVal) : nil
+    end
+    
+    def Parent
+      NotesDocument.new(@raw_object.Parent)
+    end
+    
+    ACTIONCD = 16       # saved action CD records; non-Computable; canonical form.
+    ASSISTANTINFO = 17  # saved assistant information; non-Computable; canonical form.
+    ATTACHMENT = 1084   # file attachment.
+    AUTHORS = 1076      # authors.
+    COLLATION = 2       # COLLATION?
+    DATETIMES = 1024    # date-time value or range of date-time values.
+    EMBEDDEDOBJECT = 1090 # embedded object.
+    ERRORITEM = 256     # an error occurred while accessing the type.
+    FORMULA = 1536      # Notes formula.
+    HTML = 21           # HTML source text.
+    ICON = 6            # icon.
+    LSOBJECT = 20       # saved LotusScript Object code for an agent.
+    MIME_PART = 25      # MIME support.
+    NAMES = 1074        # names.
+    NOTELINKS = 7       # link to a database, view, or document.
+    NOTEREFS = 4        # reference to the parent document.
+    NUMBERS = 768       # number or number list.
+    OTHEROBJECT = 1085  # other object.
+    QUERYCD = 15        # saved query CD records; non-Computable; canonical form.
+    READERS = 1075      # readers.
+    RFC822Text = 1282   # RFC822 Internet mail text.
+    RICHTEXT = 1        # rich text.
+    SIGNATURE = 8       # signature.
+    TEXT = 1280         # text or text list.
+    UNAVAILABLE = 512   # the item type isn't available.
+    UNKNOWN = 0         # the item type isn't known.
+    USERDATA = 14       # user data.
+    USERID = 1792       # user ID name.
+    VIEWMAPDATA = 18    # saved ViewMap dataset; non-Computable; canonical form.
+    VIEWMAPLAYOUT = 19  # saved ViewMap layout; non-Computable; canonical form.
+    def Type
+      @raw_object.Type
+    end
+    
+    def Text
+      @raw_object.text
+    end
+    
+    def ValueLength
+      @raw_object.ValueLength
+    end
+    alias length ValueLength
+    
+    
+    def Values
+      @raw_object.Values
+    end
+    alias values Values
+    
+    
+    def AppendToTextList( newValue )
+      @raw_object.AppendToTextList( newValue )
+    end
+    
+    def contains?(value)
+      @raw_object.Contains(value)
+    end
+    
+    def CopyItemToDocument( otherDoc, newName=nil )
+      unless newName
+        newName = self.Name
+      end
+      raw_newItem = @raw_object.CopyItemToDocument( toRaw(otherDoc), newName )
+      NotesItem.new(raw_newItem)
+    end
+    
+    def GetValueDateTimeArray()
+      rawDateTimeArray = @raw_object.GetValueDateTimeArray()
+      return nil unless rawDateTimeArray
+      ret_list = []
+      rawDateTimeArray.each {|rawDateTime|
+        # ? �ǂ������NotesDateTime�� NotesDateRange����ʂ����?
+        ret_list.push NotesDateTime.new(rawDateTime)
+        raise "Not Implement"
+      }
+    end
+    
+    def GetMIMEEntity()
+      rawMIMEEntry = @raw_object.GetMIMEEntity()
+      rawMIMEEntry ? NotesMIMEEntity.new(rawMIMEEntry) : nil
+    end
+    
+    def Remove
+      @raw_object.Remove()
+      @raw_object = nil
+    end
+    
+    # ----- Additional Methods ----
+    def Values=(item_value)
+      # @raw_object.Type returns data type of field(ex: RICH_TYP,DATE_TYP...)
+      case @raw_object.Type
+      when RICH_TYP
+        val_array = [item_value].flatten
+        raw_doc = self.Parent.raw
+        item_name = @raw_object.Name
+        raw_doc.RemoveItem(item_name)
+        new_item = raw_doc.CreateRichTextItem( item_name )
+        @raw_object = new_item.AppendText(val_array.join(""))
+      else
+        val_array = [item_value].flatten
+        raw_doc = self.Parent.raw
+        item_name = @raw_object.Name
+        raw_newitem = raw_doc.ReplaceItemValue(item_name, val_array)
+        @raw_object = raw_newitem   # replace @raw_object
+      end
+    end
+    alias text= Values=
+    
+    ItemTypeDic = {
+      16=>'ACTIONCD', 17=>'ASSISTANTINFO', 1084=>'ATTACHMENT', 1076=>'AUTHORS', 2=>'COLLATION', 1024=>'DATETIMES', 
+      1090=>'EMBEDDEDOBJECT', 256=>'ERRORITEM', 1536=>'FORMULA', 21=>'HTML', 6=>'ICON', 20=>'LSOBJECT', 25=>'MIME_PART', 
+      1074=>'NAMES', 7=>'NOTELINKS', 4=>'NOTEREFS', 768=>'NUMBERS', 1085=>'OTHEROBJECT', 15=>'QUERYCD', 1075=>'READERS', 
+      1282=>'RFC822Text', 1=>'RICHTEXT', 8=>'SIGNATURE', 1280=>'TEXT', 512=>'UNAVAILABLE', 0=>'UNKNOWN', 14=>'USERDATA', 
+      1792=>'USERID', 18=>'VIEWMAPDATA', 19=>'VIEWMAPLAYOUT'
+    }
+    def inspect
+      if self.Values == nil
+        val = self.text
+      elsif self.Values.size > 1
+        val = self.Values
+      else
+        val = self.Text
+      end
+      "<#{self.class}, Type:#{ItemTypeDic[self.Type]}, #{self.name.inspect}=>#{val.inspect}>"
+    end
+    
+    def each_value
+      @raw_object.Values.each {|val|
+        yield val
+      }
+    end
+    
+    def EmbeddedObjects
+      []
+    end
+    
+    def to_s
+      self.Text
+    end
+    
+    def CopyItem(other_item)
+      parent_doc = self.Parent
+      @raw_object = parent_doc.CopyItem(other_item, self.Name)
+    end
+    
+  end
+end

data/lib/notesgrip/NotesRichTextItem.rb

@@ -0,0 +1,256 @@
+module Notesgrip
+  # ====================================================
+  # =========== NotesRichTextItem Class ================
+  # ====================================================
+  class NotesRichTextItem < NotesItem
+    EMBED_ATTACHMENT = 1454
+    EMBED_OBJECT = 1453
+    EMBED_OBJECTLINK = 1452
+    def EmbeddedObjects
+      obj_list = []
+      return obj_list unless @raw_object.EmbeddedObjects
+      @raw_object.EmbeddedObjects.each {|rawEmbObj|
+        obj_list.push NotesEmbeddedObject.new(rawEmbObj)
+      }
+      obj_list
+    end
+    
+    def AddNewLine( n=1, forceParagraph=true )
+      @raw_object.AddNewLine( n, forceParagraph)
+    end
+    
+    def AppendDocLink( linkTo, comment=nil, hotSpotText=nil )
+      raw_linkTo = toRaw(linkTo)
+      @raw_object.AppendDocLink( raw_linkTo, comment, hotSpotText )
+    end
+    
+    def AppendParagraphStyle( paragStyle )
+      raw_paragStyle = toRaw(paragStyle)
+      @raw_object.AppendParagraphStyle( raw_paragStyle )
+    end
+    
+    def AppendRTItem( otherRichItem )
+      raw_otherRichItem = toRaw(otherRichItem)
+      @raw_object.AppendRTItem( raw_otherRichItem )
+    end
+    
+    def AppendStyle( richTextStyle )
+      raw_richTextStyle = toRaw(richTextStyle)
+      @raw_object.AppendStyle( raw_richTextStyle )
+    end
+    
+    def AppendTable( rows, columns, labels=nil, leftMargin=1440, rtpsStyleArray=nil )
+      raw_styleArray = []
+      if rtpsStyleArray
+        rtpsStyleArray.each {|rtpsStyle|
+          raw_styleArray.push toRaw(rtpsStyle)
+        }
+      end
+      @raw_object.AppendTable( rows, columns, labels, leftMargin, raw_styleArray )
+    end
+    
+    def AppendText( text )
+      @raw_object.AppendText( text )
+    end
+    
+    def BeginInsert( element, after=false )
+      raw_element = toRaw(element)
+      @raw_object.BeginInsert(raw_element)
+    end
+    
+    def BeginSection( title, titleStyle=nil, barColor=nil, expand=false )
+      raw_titleStyle = toRaw(titleStyle)
+      raw_barColor = toRaw(barColor)
+      @raw_object.BeginSection( title, raw_titleStyle, raw_barColor, expand)
+    end
+    
+    def CreateNavigator()
+      raw_RichTextNavigator = @raw_object.CreateNavigator()
+      NotesRichTextNavigator.new(raw_RichTextNavigator)
+    end
+    
+    def CreateRange()
+      raw_notesRichTextRange = @raw_object.CreateRange()
+      NotesRichTextRange.new(raw_notesRichTextRange)
+    end
+    
+    def EmbedObject( type, appClass, source )
+      case type
+      when EMBED_ATTACHMENT
+        fullpath = FileSystemObject.instance.fullpath(source)
+        added_object = @raw_object.EmbedObject( EMBED_ATTACHMENT, "", fullpath)
+      when EMBED_OBJECT
+        added_object = @raw_object.EmbedObject( EMBED_OBJECT, appClass, "")
+      when EMBED_OBJECTLINK
+        added_object = @raw_object.EmbedObject( EMBED_OBJECTLINK, "", source)
+      else
+        raise "Illegal Type."
+      end
+      NotesEmbeddedObject.new(added_object)
+    end
+    
+    def GetEmbeddedObject( name )
+      raw_EmbeddedObject = @raw_object.GetEmbeddedObject( name )
+      raw_EmbeddedObject ? NotesEmbeddedObject.new(raw_EmbeddedObject) : nil
+    end
+    
+    def GetFormattedText( tabstrip, lineLength=0 )
+      @raw_object.GetFormattedText( tabstrip, lineLength )
+    end
+    
+    def [](embobj_name)
+      raw_embobj = @raw_object.GetEmbeddedObject(embobj_name)
+      if raw_embobj
+        NotesEmbeddedObject.new(raw_embobj)
+      else
+        nil
+      end
+    end
+    
+    def add_file(filename)
+      self.EmbedObject(EMBED_ATTACHMENT, "", filename)
+    end
+    
+    def inspect
+      val = self.Text
+      "<#{self.class}, Type:#{ItemTypeDic[self.Type]}, #{self.name.inspect}=>#{val.inspect}>"
+    end
+  end
+
+  # ====================================================
+  # ============= NotesEmbeddedObject Class ================
+  # An embedded object(attached file(EMBED_ATTACHMENT), object link(EMBED_OBJECTLINK), OLE(EMBED_OBJECT), etc)
+  # ====================================================
+  class NotesEmbeddedObject < GripWrapper
+    EMBED_ATTACHMENT = 1454
+    EMBED_OBJECT = 1453
+    EMBED_OBJECTLINK = 1452
+    TypeDic = {
+      1454=>'EMBED_ATTACHMENT', 1453=>'EMBED_OBJECT', 1452=>'EMBED_OBJECTLINK'
+    }
+    def Parent
+      NotesRichTextItem.new(@raw_object.Parent)
+    end
+    alias parent Parent
+    
+    def ExtractFile( path )
+      fullpath = FileSystemObject.instance.fullpath(path)
+      @raw_object.ExtractFile(fullpath)
+    end
+    
+    def Remove()
+      @raw_object.Remove()
+      @raw_object = nil
+    end
+    
+    def inspect
+      "<#{self.class} Type:#{TypeDic[self.Type]} Name:#{self.Name.inspect}>"
+    end
+  end
+
+  # ====================================================
+  # ================= NotesRichTextRange Class ===============
+  # Represents a range of elements in a rich text item.
+  # ====================================================
+  class NotesRichTextRange < GripWrapper
+    def Navigator
+      raw_richTextNavigator = @raw_object.Vavigator
+      NotesRichTextNavigator.new(raw_richTextNavigator)
+    end
+    
+    def Style
+      raw_richTextStyle = @raw_object.Stle
+      NotesRichTextStyle.new(raw_richTextStyle)
+    end
+    
+    RTELEM_TYPE_DOCLINK = 5
+    RTELEM_TYPE_FILEATTACHMENT = 8
+    RTELEM_TYPE_OLE = 9
+    RTELEM_TYPE_SECTION = 6
+    RTELEM_TYPE_TABLE = 1
+    RTELEM_TYPE_TABLECELL = 7
+    RTELEM_TYPE_TEXTPARAGRAPH = 4
+    RTELEM_TYPE_TEXTPOSITION = 10
+    RTELEM_TYPE_TEXTRUN = 3
+    RTELEM_TYPE_TEXTSTRING = 11
+    def Type
+      @raw_object.Type
+    end
+    
+    def Clone
+      raw_richTextRange = @raw_object.Clone
+      NotesRichTextRange.new(raw_richTextRange)
+    end
+    
+    RT_FIND_ACCENTINSENSITIVE = 4 # accent insensitive search (default is accent sensitive)
+    RT_FIND_CASEINSENSITIVE = 1 # case insensitive search (default is case sensitive)
+    RT_FIND_PITCHINSENSITIVE = 2 # pitch insensitive search (default is pitch sensitive)
+    RT_REPL_ALL = 16    # replace all occurrences of the search string
+    RT_REPL_PRESERVECASE = 8 # preserve case in the replacement string
+    def FindAndReplace( target , replacemen, options=0 )
+      @raw_object.FindAndReplace( target , replacemen, options )
+    end
+    
+    def Remove
+      @raw_object.Remove
+      @raw_object = nil
+    end
+    
+    def SetBegin( element )
+      raw_element = toRaw(element)
+      @raw_object.SetBegin(raw_element)
+    end
+    
+    def SetEnd( element )
+      raw_element = toRaw(element)
+      @raw_object.SetEnd(raw_element)
+    end
+    
+    def SetStyle( style )
+      raw_style = toRaw(style)
+      @raw_object.SetStyle(raw_style)
+    end
+  end
+  
+  class NotesRichTextSection < GripWrapper
+  end
+  
+  class NotesRichTextStyle < GripWrapper
+  end
+  
+  class NotesRichTextTab < GripWrapper
+  end
+  
+  # ====================================================
+  # ================= NotesRichTextTable Class ===============
+  # Represents a table in a rich text item.
+  # ====================================================
+  class NotesRichTextTable < GripWrapper
+  end
+  
+  class NotesRichTextDocLink < GripWrapper
+  end
+  
+  class NotesRichTextNavigator < GripWrapper
+  end
+  
+  class NotesRichTextParagraphStyle < GripWrapper
+  end
+  
+  class NotesMIMEEntity < GripWrapper
+  end
+  
+  class NotesMIMEHeader < GripWrapper
+  end
+  
+  class FileSystemObject
+    include Singleton
+    def initialize
+      @body =  WIN32OLE.new('Scripting.FileSystemObject')
+    end
+    
+    def fullpath(filename)
+      @body.getAbsolutePathName(filename)
+    end
+  end
+end