#
#--
# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
# All rights reserved.
# 
# Redistribution and use in source and binary forms, with or without 
# modification, are permitted provided that the following conditions are met:
# 
# . Redistributions of source code must retain the above copyright notice, this
#   list of conditions and the following disclaimer.  
# 
# . Redistributions in binary form must reproduce the above copyright notice, 
#   this list of conditions and the following disclaimer in the documentation 
#   and/or other materials provided with the distribution.
# 
# . Neither the name of the "OpenWFE" nor the names of its contributors may be
#   used to endorse or promote products derived from this software without
#   specific prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
# POSSIBILITY OF SUCH DAMAGE.
#++
#
# $Id: workitem.rb 3556 2006-11-13 04:15:52Z jmettraux $
#

#
# "hecho en Costa Rica"
#
# john.mettraux@openwfe.org
#

require 'base64'

require 'openwfe/utils'

require 'openwfe/rest/definitions'
    # hmmm, only used for MAP_TYPE


module OpenWFE

    #
    # WORKITEMS
    #

    #
    # The base class for all the workitems.
    #
    class WorkItem

        attr_accessor :last_modified, :attributes

        def initialize ()

            @last_modified = nil

            @attributes = {}
            @attributes[MAP_TYPE] = E_SMAP
        end

        alias :fields :attributes
        alias :fields= :attributes=

        #
        # In order to simplify code like :
        #
        #    value = workitem.attributes['xyz']
        #
        # to
        #
        #    value = workitem.xyz
        #
        # or
        # 
        #    value = workitem['xyz']
        #
        # we overrode method_missing.
        #
        #    workitem.xyz = "my new value" 
        #
        # is also possible
        #
        def method_missing (m, *args)

            methodname = m.to_s

            if args.length == 0
                value = @attributes[methodname]
                return value if value
                raise "Missing attribute '#{methodname}' in workitem"
            end

            if methodname == "[]" and args.length == 1
                value = @attributes[args[0]]
                return value if value
                raise "Missing attribute '#{methodname}' in workitem"
            end

            if methodname == "[]=" and args.length == 2
                return @attributes[args[0]] = args[1]
            end

            if args.length == 1 and methodname[-1, 1] == "="
                return @attributes[methodname[0..-2]] = args[0]
            end

            super(m, args)
        end

        def dup
            return OpenWFE::fulldup(self)
        end
    end

    #
    # The common parent class for InFlowWorkItem and CancelItem.
    #
    class InFlowItem < WorkItem

        attr_accessor :flow_expression_id, :participant_name

        def last_expression_id
            return @flow_expression_id
        end

        def last_expression_id= (fei)
            @flow_expression_id = fei
        end

        #
        # Just a handy alias for flow_expression_id
        #
        alias :fei :flow_expression_id
        alias :fei= :flow_expression_id=
    end

    #
    # When the term 'workitem' is used it's generally referring to instances
    # of this InFlowWorkItem class.
    # InFlowWorkItem are circulating within process instances and carrying
    # data around. Their 'payload' is located in their attribute Hash field.
    #
    class InFlowWorkItem < InFlowItem

        attr_accessor :dispatch_time, :filter, :history

        attr_accessor :store
            #
            # special : added by the ruby lib, not given by the worklist

        #
        # Outputting the workitem in a human readable format
        #
        def to_s
            s = ""
            s << "  >>>#{self.class}>>>\n"
            s << "  - flow_expression_id : #{@flow_expression_id}\n"
            s << "  - participant_name :   #{@participant_name}\n"
            s << "  - last_modified :      #{@last_modified}\n"
            s << "  - dispatch_time :      #{@dispatch_time}\n"
            s << "  - attributes :\n"
            @attributes.each do |k, v|
                s << "    * '#{k}' --> '#{v}'\n"
            end
            s << "  <<<#{self.class}<<<"
            return s
        end
    end

    #
    # When it needs to cancel a branch of a process instance, the engine
    # emits a CancelItem towards it.
    # It's especially important for participants to react correctly upon
    # receiving a cancel item.
    #
    class CancelItem < InFlowItem

        def initialize (workitem)
            super()
            @flow_expression_id = workitem.fei.dup
        end
    end

    #
    # LaunchItem instances are used to instantiate and launch processes.
    # They contain attributes that are used as the initial payload of the 
    # workitem circulating in the process instances.
    #
    class LaunchItem < WorkItem

        attr_accessor :workflow_definition_url
            #, :description_map

        #
        # This constructor will build an empty launchitem.
        # If the optional parameter process_definition is set, the
        # definition will be embedded in the launchitem attributes
        # for retrieval by the engine.
        #
        def initialize (process_definition=nil)

            super()

            if process_definition
                @workflow_definition_url = "field:__definition"
                @attributes['__definition'] = process_definition
            end
        end
    end


    #
    # HISTORY ITEM
    #

    #
    # HistoryItem instances are used to keep track of what happened to
    # a workitem.
    #
    class HistoryItem

        attr_accessor \
            :date, \
            :author, \
            :host, \
            :text, \
            :wfd_name, \
            :wfd_revision, \
            :wf_instance_id, \
            :expression_id
        
        def dup
            return OpenWFE::fulldup(self)
        end
    end


    #
    # STORES
    #

    #
    # Models the information about a store as viewed by the current user 
    # (upon calling the listStores or getStoreNames methods)
    #
    class Store

        attr_accessor :name, :workitem_count, :permissions

        def initialize ()
            super()
            #@name = nil
            #@workitem_count = nil
            #@permissions = nil
        end

        #
        # Returns true if the current user may read headers and workitems
        # from this store
        #
        def may_read? ()
            return @permissions.index('r') > -1
        end

        #
        # Returns true if the current user may modify workitems (and at least
        # proceed/forward them) in this store
        #
        def may_write? ()
            return @permissions.index('w') > -1
        end

        #
        # Returns true if the current user may browse the headers of this
        # store
        #
        def may_browse? ()
            return @permissions.index('b') > -1
        end

        #
        # Returns true if the current user may delegate workitems to this store
        #
        def may_delegate? ()
            return @permissions.index('d') > -1
        end
    end

    #
    # A header is a summary of a workitem, returned by the getHeader
    # worklist method
    #
    class Header

        attr_accessor \
            :last_modified, :locked, :flow_expression_id, :attributes
    end


    #
    # MISC ATTRIBUTES
    #
    # in openwfe-ruby, OpenWFE attributes are immediately mapped to
    # Ruby instances, but some attributes still deserve their own class
    #

    #
    # a wrapper for some binary content
    #
    class Base64Attribute

        attr_accessor :content

        def initialize (base64content)

            @content = base64content
        end

        #
        # dewraps (decode) the current content and returns it
        #
        def dewrap ()

            return Base64.decode64(@content)
        end

        #
        # wraps some binary content and stores it in this attribute
        # (class method)
        #
        def Base64Attribute.wrap (binaryData)

            return Base64Attribute.new(Base64.encode64(binaryData))
        end
    end


    #
    # LAUNCHABLE
    # 

    #
    # A worklist will return list of Launchable instances indicating
    # what processes (URL) a user may launch on which engine.
    #
    class Launchable

        attr_accessor :url, :engine_id
    end


    #
    # Expression, somehow equivalent to FlowExpression, but only used 
    # by the control interface.
    #
    class Expression

        attr_accessor :id, :apply_time, :state, :state_since
    end

end