cpee-worklist 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 59ae04616e62aed19b864c9e592bb02c26748121c99088713d1f4dfcce9411df
+  data.tar.gz: d92a64bd471d4c44cdafd6a32595a3c7cc3a53bb4f7ffe596612a803fb4159c7
+SHA512:
+  metadata.gz: af8ffc66af266196228708e7639ffa3a613b487dc57d81b9ab667368e43d382ada743917a4c95aab890489c8b8a3c5131e1958bc3486d4648600ad1143310d94
+  data.tar.gz: 40059cbe217575aa2de00b3b49da4522d585805b397071e73adc08c5304830b11b64758b81396e75b560b1eb771ba3810c02bc3fd82b326732186869b5747626

data/AUTHORS

@@ -0,0 +1,3 @@
+Jürgen 'eTM' Mangler <juergen.mangler@univie.ac.at>
+Florian 'Triarier' Stertz <florian.stertz@gmail.com>
+Patrik 'The King' Koenig

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,21 @@
+All code in this package is provided under the LGPL-3 license.
+Please read the file COPYING.
+
+Tested for MRI > 2.7
+
+# Installation
+
+Clone. Install dependencies:
+
+```bash
+gem install --user cpee cpee-worklist
+```
+
+# Run
+
+* Link the directory "ui" into your webserver.
+* Goto server directory and run
+
+```bash
+./server -v restart
+```

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+require 'rubygems/package_task'
+
+spec = eval(File.read('cpee-worklist.gemspec'))
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+  FileUtils.mkdir 'pkg' rescue nil
+  FileUtils.rm_rf Dir.glob('pkg/*')
+  FileUtils.ln_sf "#{pkg.name}.gem", "pkg/#{spec.name}.gem"
+end
+
+task :default => [:gem]
+
+task :push => :gem do |r|
+  `gem push pkg/cpee-worklist.gem`
+end
+
+task :install => :gem do |r|
+  `gem install pkg/cpee-worklist.gem`
+end

data/cpee-worklist.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name             = "cpee-worklist"
+  s.version          = "1.0.0"
+  s.platform         = Gem::Platform::RUBY
+  s.license          = "LGPL-3.0-or-later"
+  s.summary          = "Worklist for the cloud process execution engine (cpee.org)"
+
+  s.description      = "see http://cpee.org"
+
+  s.files            = Dir['{server/worklist,server/worklist.conf,lib/**/*}'] + %w(LICENSE Rakefile cpee-worklist.gemspec README.md AUTHORS)
+  s.require_path     = 'lib'
+  s.extra_rdoc_files = ['README.md']
+  s.bindir           = 'tools'
+  s.executables      = ['cpee-worklist']
+
+  s.required_ruby_version = '>=2.4.0'
+
+  s.authors          = ['Juergen eTM Mangler','Florian Stertz', 'Patrik Koenig']
+
+  s.email            = 'juergen.mangler@gmail.com'
+  s.homepage         = 'http://cpee.org/'
+
+  s.add_runtime_dependency 'riddl', '~> 1.0'
+  s.add_runtime_dependency 'json', '~> 2.1'
+  s.add_runtime_dependency 'cpee', '~> 2.1', '>= 2.1.56'
+  s.add_runtime_dependency 'chronic_duration', '~> 0.10', '>= 0.10.6'
+end

data/lib/cpee-worklist/activities.rb

@@ -0,0 +1,36 @@
+# This file is part of CPEE-WORKLIST
+#
+# CPEE-WORKLIST is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# CPEE-WORKLIST is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CPEE-WORKLIST (file LICENSE in the main directory). If not, see
+# <http://www.gnu.org/licenses/>.
+
+module CPEE
+  module Worklist
+    class Activities < Array
+      def initialize(opts)
+        super()
+        @opts = opts
+      end
+
+      def unserialize
+        self.clear.replace JSON.parse!(File.read(File.join(@opts[:top],'activities.sav'))) rescue []
+      end
+
+      def  serialize
+        Thread.new do
+          File.write File.join(@opts[:top],'activities.sav'), JSON.pretty_generate(self)
+        end
+      end
+    end
+  end
+end

data/lib/cpee-worklist/controller.rb

@@ -0,0 +1,160 @@
+# This file is part of CPEE-WORKLIST
+#
+# CPEE-WORKLIST is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# CPEE-WORKLIST is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CPEE-WORKLIST (file LICENSE in the main directory). If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'cpee/persistence'
+CPEE::Persistence::obj = 'worklist'
+
+module CPEE
+  module Worklist
+
+    class Controller
+      attr_reader :communication, :events, :notifications, :activities, :callback_keys, :votes, :opts, :orgmodels
+
+      def initialize(opts)
+        CPEE::redis_connect(opts,"Main")
+        @opts = opts
+
+        @redis = opts[:redis]
+        @votes = []
+
+        @activities = Activities.new(opts)
+        @activities.unserialize
+
+        CPEE::Persistence::new_static_object(CPEE::Persistence::obj,opts)
+
+        @orgmodels = []
+        Dir::glob(File.join(@opts[:top],'orgmodels','*')).each do |g|
+          add_orgmodel File.basename(g), File.read(g)
+        end
+
+        @callback_keys = {}
+        @psredis = @opts[:redis_dyn].call "Callback Response"
+
+        Thread.new do
+          @psredis.psubscribe('callback-response:*','callback-end:*') do |on|
+            on.pmessage do |pat, what, message|
+              if pat == 'callback-response:*' && @callback_keys.has_key?(what[18..-1])
+                index = message.index(' ')
+                mess = message[index+1..-1]
+                instance = message[0...index]
+                m = JSON.parse(mess)
+                resp = []
+                m['content']['values'].each do |e|
+                  if e[1][0] == 'simple'
+                    resp << Riddl::Parameter::Simple.new(e[0],e[1][1])
+                  elsif e[1][0] == 'complex'
+                    resp << Riddl::Parameter::Complex.new(e[0],e[1][1],File.open(e[1][2]))
+                  end
+                end
+                @callback_keys[what[18..-1]].send(:callback,resp,m['content']['headers'])
+              end
+              if pat == 'callback-end:*'
+                @callback_keys.delete(what[13..-1])
+              end
+            end
+          end
+        end
+      end
+
+      def id
+        'worklist'
+      end
+      def uuid
+        @id
+      end
+      def host
+        @opts[:host]
+      end
+      def base_url
+        File.join(@opts[:url],'/')
+      end
+      def instance_url
+        File.join(@opts[:url].to_s,'/')
+      end
+      def instance_id
+        @id
+      end
+      def base
+        base_url
+      end
+
+      def info
+        'worklist'
+      end
+
+      def add_orgmodel(name,content) #{{{
+        FileUtils.mkdir_p(File.join(@opts[:top],'orgmodels'))
+        @orgmodels << name unless @orgmodels.include?(name)
+        File.write(File.join(@opts[:top],'orgmodels',name), content)
+      end #}}}
+
+      def notify(what,content={})
+        CPEE::Message::send(:event,what,base,info,uuid,info,content,@redis)
+      end
+
+      def vote(what,content={})
+        topic, name = what.split('/')
+        handler = File.join(topic,'vote',name)
+        votes = []
+        CPEE::Persistence::extract_handler(id,@opts,handler).each do |client|
+          voteid = Digest::MD5.hexdigest(Kernel::rand().to_s)
+          content[:key] = voteid
+          content[:subscription] = client
+          votes << voteid
+          CPEE::Message::send(:vote,what,base,info,uuid,info,content,@redis)
+        end
+
+        if votes.length > 0
+          @votes += votes
+          psredis = @opts[:redis_dyn].call "Vote"
+          collect = []
+          psredis.subscribe(votes.map{|e| ['vote-response:' + e.to_s] }.flatten) do |on|
+            on.message do |what, message|
+              index = message.index(' ')
+              mess = message[index+1..-1]
+              m = JSON.parse(mess)
+              collect << ((m['content'] == true || m['content'] == 'true') || false)
+              @votes.delete m['name']
+              cancel_callback m['name']
+              if collect.length >= votes.length
+                psredis.unsubscribe
+              end
+            end
+          end
+          !collect.include?(false)
+        else
+          true
+        end
+      end
+
+      def callback(hw,key,content)
+        CPEE::Message::send(:callback,'activity/content',base,info,uuid,info,content.merge(:key => key),@redis)
+        @callback_keys[key] = hw
+      end
+
+      def cancel_callback(key)
+        CPEE::Message::send(:'callback-end',key,base,info,uuid,info,{},@redis)
+      end
+
+      def add_activity(activity)
+        @activities << activity
+        @activities.serialize
+      end
+
+    end
+
+  end
+end