@_text@" + set template "@_text@" + } else { + set template "@[join $vars @,@]@
@_text@" + } + #my log "USE auto-form template=$template, vars=$vars IA=[$object set instance_attributes], V=[$object info vars] auto [expr {[my exists autoname] ? [my set autoname] : "f"}]" + + if {[my exists auto_form_constraints]} { + set fc [my set auto_form_constraints] + } else { + set fc "" + } + set form_id [::xowiki::Form new -destroy_on_cleanup \ + -package_id $package_id \ + -parent_id [$package_id folder_id] \ + -name "Auto-Form" \ + -anon_instances [expr {[my exists autoname] ? [my set autoname] : "f"}] \ + -form {} \ + -text [list $template text/html] \ + -form_constraints $fc] + } else { + # Be sure, to instantiate the form object + if {![my isobject ::$form_id]} { + ::xo::db::CrClass get_instance_from_db -item_id $form_id + } + #my msg form_id=$form_id,[$form_id info class] + + set form_id ::$form_id + if {[$form_id info class] eq "::xowiki::Form"} { + # The item returned from the form loadeder was a form, + # everything is fine. + } elseif {[$form_id info class] eq "::xowiki::FormPage"} { + # We got an FormPage. This formpage might be already a pseudo + # form (containing property "form"). In this case, we are done as well. + + if {[$form_id property form] eq ""} { + # The FormPage contains no form, so try to provide one. We + # obtain the content by rendering the page_content. In some + # cases it might be more efficient to obtain the content + # from property "_text", but this might lead to unexpected + # cases where the formpage uses _text for partial + # information. + set text [$form_id render_content] + $form_id set_property -new 1 form "" + #my msg "_text=[$form_id property _text]" + } + } elseif {[$form_id info class] eq "::xowiki::Page"} { + #my msg "creating form" + set form_id [::xowiki::Form new -destroy_on_cleanup \ + -package_id $package_id \ + -parent_id [$package_id folder_id] \ + -name "Auto-Form" \ + -anon_instances [expr {[my exists autoname] ? [my set autoname] : "f"}] \ + -form "" \ + -text "" \ + -form_constraints ""] + } + } + my set form_id $form_id + } + + Context instproc init {} { + my destroy_on_cleanup + my array set handled_roles {} + # + # We define the classes Action, State and Property per workflow + # instance. This has the advantage that we can provide instprocs + # or parameters per workflow definition without the danger to + # interfere with other Workflows + # + regsub -all \r\n [my workflow_definition] \n workflow_definition + + if {[catch {my contains " + Class create Action -superclass ::xowf::Action + Class create State -superclass ::xowf::State + Class create Condition -superclass ::xowf::Condition + Class create Property -superclass ::xowf::Property -set abstract 1 + [my default_definition] + $workflow_definition"} errorMsg]} { + my msg "Error in workflow definition: $errorMsg" + #my msg [[my object] instance_attributes] + #array set __ia [[my object] instance_attributes] + #catch {unset __ia(workflow_definition)} + #catch {[my object] unset __ia(workflow_definition)} + #catch {[my object] unset __wf(workflow_definition)} + #[my object] instance_attributes [array get __ia] + #[my object] save + #my msg [[my object] serialize] + } + + if {[my all_roles]} { + #my msg want.to.create=[my array names handled_roles] + foreach role [my array names handled_roles] { + Context create [self]-$role -workflow_definition $workflow_definition \ + -in_role $role -object [my object] + } + } + } + + Context proc require {obj} { + set ctx $obj-wfctx + if {![my isobject $ctx]} { + set wfContextClass [$obj wf_property workflow_context_class [self]] + $wfContextClass create $ctx -destroy_on_cleanup -object $obj \ + -workflow_definition [$obj wf_property workflow_definition] + + # set the state to a well defined starting point + set state [$obj state] + if {$state eq ""} {set state initial} + $ctx set_current_state $state + + if {[info commands [$ctx current_state]] eq ""} { + # The state was probably deleted from the workflow definition, + # but the workflow instance does still need it. We complain an + # reset the state to initial, which should be always present. + $obj msg "Workflow instance [$obj name] is in an undefined state $state, reset to initial" + set state initial + $ctx set_current_state $state + } + + set stateObj [$ctx current_state] + catch {$stateObj eval [$stateObj eval_when_active]} + + # set the embedded context to the workflow context, + # used e.g. by "behavior" of form-fields + [[$obj package_id] context] set embedded_context $ctx + + if {[$obj istype ::xowiki::FormPage] && [$obj is_wf_instance]} { + # + # The workflow instance may have the following variables: + # - "debug" + # - "policy" + # - "autoname" + # - "auto_form_constraints" + # - "auto_form_template" + # + if {[$ctx exists debug] && [$ctx set debug]>0} { + $ctx show_debug_info $obj + } + # anything to do with autoname? + #if {[$ctx exists autoname]} { + # my log obj=[$obj info class],obj=$obj + # $obj set_property -new 1 anon_instances t + #} + + if {[$ctx exists policy]} { + set policy [$ctx set policy] + if {![my isobject $policy]} { + my msg "ignore non-existent policy '$policy'" + } else { + [$obj package_id] set policy $policy + #my msg new-pol=[[$obj package_id] set policy ] + } + } + } + } + return $ctx + } + + Context instproc show_debug_info {obj} { + set stateObj [my current_state] + set form [$stateObj form] + set view_method [my get_view_method] + set form_loader [my form_loader] + if {$form eq ""} {set form NONE} + if {$view_method eq ""} {set view_method NONE} + if {$form_loader eq ""} {set form_loader NONE} + + $obj debug_msg "State: [$stateObj name], Form: $form,\ + View method: $view_method, Form loader: $form_loader,\ + Context class: [my info class]" + + set conds [list] + foreach c [my defined Condition] { + lappend conds "[$c name] [$c]" + } + $obj debug_msg "Conditions: [join $conds {, }]" + $obj debug_msg "Instance attributes: [list [$obj instance_attributes]]" + } + + Context instproc draw_arc {from_state next_state action label style} { + if {$next_state eq ""} {set next_state $from_state} + set key transition($from_state,$next_state,$action) + if {[my exists $key]} {return ""} + my set $key 1 + return " state_$from_state -> state_$next_state \[label=\"$label\"$style\];\n" + } + Context instproc draw_transition {from action role} { + #my msg "[self args]" + + if {[$action state_safe]} { + set arc_style {,style="dashed",penwidth=1,color=gray} + } else { + set arc_style "" + } + set cond_values [$action get_cond_values [$action next_state]] + set result "" + if {[llength $cond_values]>2} { + # we have conditional values + set c cond_[$from name]_[my incr condition_count] + append arc_style {,style="setlinewidth(1)",penwidth=1,color=gray} + append result " state_$c \[shape=diamond, fixedsize=1, width=0.2, height=0.2, fixedsize=1,style=solid,color=gray,label=\"\"\];\n" + append result [my draw_arc [$from name] $c [$action name]-1 $role[$action label] ""] + foreach {cond value} $cond_values { + if {$cond ne ""} {set prefix "$cond"} {set prefix "else"} + append result [my draw_arc $c $value [$action name] \[$prefix\] $arc_style] + } + } else { + set prefix "" + append result [my draw_arc [$from name] [lindex $cond_values 1] [$action name] $role$prefix[$action label] $arc_style] + } + return $result + } + + Context instproc as_graph {{-current_state ""} {-visited ""} {-dpi 96} {-style "width:100%"}} { + set dot "" + catch {set dot [::util::which dot]} + # final ressort for cases, where ::util::which is not available + if {$dot eq "" && [file executable /usr/bin/dot]} {set dot /usr/bin/dot} + if {$dot eq ""} {return "Program 'dot' is not available! No graph displayed."} + set obj_id [namespace tail [my object]] + set result [subst {digraph workflow_$obj_id \{ + dpi = $dpi; + node \[shape=doublecircle, margin=0.001, fontsize=8, fixedsize=1, width=0.4, style=filled\]; start; + node \[shape=ellipse, fontname="Courier", color=lightblue2, style=filled, + fixedsize=0, fontsize=10, margin=0.06\]; + edge \[fontname="Courier", fontsize=9\]; + }] + foreach s [my defined State] { + if {[$s name] eq $current_state} { + set color ",color=orange" + } elseif {[$s name] in $visited} { + set color ",color=yellow" + } else { + set color "" + } + append result " state_[$s name] \[label=\"[$s label]\"$color\];\n" + } + if {[my isobject [self]::initialize]} { + append result "start->state_initial \[label=\"[[self]::initialize label]\"\];\n" + } else { + append result "start->state_initial;\n" + } + + my set condition_count 0 + foreach s [my defined State] { + foreach a [$s get_actions -set true] { + append result [my draw_transition $s [self]::$a ""] + set drawn([self]::$a) 1 + } + foreach role [$s set handled_roles] { + set role_ctx [self]-$role + #my msg exists?role=$role->[self]-$role->[info command [self]-$role] + if {[info command ${role_ctx}::[$s name]] ne ""} { + foreach a [${role_ctx}::[$s name] get_actions] { + append result [my draw_transition $s ${role_ctx}::$a "$role:"] + } + } + } + } + # + # State-safe actions might be called from every state. Draw the + # arcs if not done yet. + # + foreach action [my defined Action] { + if {[info exists drawn($action)]} {continue} + if {[$action state_safe]} { + foreach s [my defined State] { + append result [my draw_transition $s $action ""] + } + } + } + + append result "\}\n" + set package_id [[my object] package_id] + set path [acs_package_root_dir [$package_id package_key]]/www/ + set fn $path/g.dot + set ofn dot-$obj_id.png + set f [open $fn w]; fconfigure $f -encoding utf-8; puts $f $result; close $f + if {[catch {exec $dot -Tpng $fn -o $path/$ofn} errorMsg]} { + my msg "Error during execution of $dot: $errorMsg" + } + file delete $fn + return "
$::errorInfo" + } + ns_log error "--WF: evaluation $error\n$::errorInfo" + return "" + } else { + # We moved get_next_state here to allow an action to infuence the + # conditions in the activation method. + set next_state [$action_command get_next_state] + ns_log notice "ACTIVATE [my name] no error next-state=$next_state" + return $next_state + } + } + + WorkflowPage instproc get_form_data args { + if {[my is_wf_instance]} { + lassign [next] validation_errors category_ids + if {$validation_errors == 0} { + #my msg "validation ok" + set cc [[my package_id] context] + foreach {name value} [$cc get_all_form_parameter] { + if {[regexp {^__action_(.+)$} $name _ action]} { + set ctx [::xowf::Context require [self]] + set next_state [my activate $ctx $action] + my log "after activate next_state=$next_state, current_state=[$ctx get_current_state], [my set instance_attributes]" + if {$next_state ne ""} { + if {[${ctx}::$next_state exists assigned_to]} { + my assignee [my get_assignee [${ctx}::$next_state assigned_to]] + } + $ctx set_current_state $next_state + } + break + } + } + } + return [list $validation_errors $category_ids] + } else { + next + } + } + + WorkflowPage instproc instantiated_form_fields {} { + # Helper method to + # - obtain the field_names from the current form, to + # - create form_field instances from that and to + # - provide the values from the instance attributes into it. + lassign [my field_names_from_form] _ field_names + set form_fields [my create_form_fields $field_names] + my load_values_into_form_fields $form_fields + return $form_fields + } + WorkflowPage ad_instproc solution_set {} { + Compute solution set in form of attribute=value pairs + based on "answer" attribute of form fields. + } { + set solutions [list] + foreach f [my instantiated_form_fields] { + if {![$f exists answer]} continue + lappend solutions [$f name]=[$f answer] + } + return [join [lsort $solutions] ", "] + } + WorkflowPage ad_instproc answer_is_correct {} { + Check, if answer is correct based on "answer" attribute of form fields + and provided user input. + } { + set correct 0 + if {[my get_from_template auto_correct] == true} { + foreach f [my instantiated_form_fields] { + #my msg "checking correctness [$f name] [$f info class] answer?[$f exists answer] -- [my get_from_template auto_correct]" + if {[$f exists answer]} { + if {[$f answer_is_correct] != 1} { + #my msg "checking correctness [$f name] failed ([$f answer_is_correct])" + set correct -1 + break + } + set correct 1 + } + } + } + return $correct + } + WorkflowPage instproc unset_temporary_instance_variables {} { + # never save/cache the following variables + my array unset __wfi + my array unset __wf + next + } + WorkflowPage instproc save_data args { + if {[my is_wf_instance]} { + #array set __ia [my instance_attributes] + set ctx [::xowf::Context require [self]] + my state [$ctx get_current_state] + #my msg "saving ia: [array get __ia]" + #my instance_attributes [array get __ia] + # + # we have to flag currently storing in hstore here, since + # saving removes the temporary variables for properties + # + if {[::xo::dc has_hstore] && [[my package_id] get_parameter use_hstore 0]} {set save_in_hstore 1} + } elseif {[my is_wf]} { + if {[::xo::dc has_hstore] && [[my package_id] get_parameter use_hstore 0]} {set save_in_hstore 1} + } + next + #my msg "save_in_hstore=[info exists save_in_hstore]" + if {[info exists save_in_hstore]} { + # "next" sets the revision_id, by not e.g. page_instance_id + my set page_instance_id [my revision_id] + my save_in_hstore + } + } + + WorkflowPage instproc double_quote {value} { + if {[regexp {[ ,\"\\=>\n\']} $value]} { + set value \"[string map [list \" \\\\\" \\ \\\\ ' ''] $value]\" + } + return $value + } + WorkflowPage instproc save_in_hstore {} { + # experimental code for testing with hstore + # to use it, do for now something like: + # + # /usr/local/pg820/bin/psql -U nsadmin -d dotlrn-test5 < /usr/local/pg820/share/postgresql/contrib/hstore.sql + # alter table xowiki_page_instance add column hkey hstore; + # CREATE INDEX hidx ON xowiki_page_instance using GIST(hkey); + # + set keys [list] + foreach {key value} [my instance_attributes] { + set v [my double_quote $value] + if {$v eq ""} continue + if {$key eq "workflow_definition"} continue + lappend keys [my double_quote $key]=>$v + } + #my msg "hkey='[join $keys ,]'" + xo::dc dml update_hstore "update xowiki_page_instance \ + set hkey = '[join $keys ,]' + where page_instance_id = [my revision_id]" + } + WorkflowPage instproc wf_property {name {default ""}} { + if {[my exists __wf]} {set key __wf($name)} else {set key __wfi($name)} + if {[my exists $key]} { return [my set $key] } + return $default + } + WorkflowPage instproc get_template_object {} { + my instvar page_template + if {[my is_wf_instance]} { + set key __wfi(wf_form_id) + if {![my exists $key]} { + set ctx [::xowf::Context require [self]] + my set $key [$ctx form_object [self]] + } + set form_obj [my set $key] + if {![my isobject $form_obj]} { + set form_id [string trimleft $form_obj :] + ::xo::db::CrClass get_instance_from_db -item_id $form_id + } + return $form_obj + } else { + return [next] + } + } + + WorkflowPage instproc create-or-use args { + #my msg "instance = [my is_wf_instance], wf=[my is_wf]" + if {[my is_wf]} { + my instvar package_id + # + # In a first step, we call "allocate". Allocate is an Action + # defined in a workflow, which is called *before* the workflow + # instance is created. Via allocate, it is e.g. possible to + # provide a computed name for the workflow instance from within + # the workflow definition. + # + set ctx [::xowf::Context require [self]] + my activate $ctx allocate + + # Check, if allocate has provided a name: + set name [my property name ""] + if {$name ne ""} { + # Ok, a name was provided. Check if an instance with this name + # exists in the current folder. + set default_lang [my lang] + set parent_id [my query_parameter "parent_id" [$package_id folder_id]] + $package_id get_lang_and_name -default_lang $default_lang -name $name lang stripped_name + set id [::xo::db::CrClass lookup -name $lang:$stripped_name -parent_id $parent_id] + #my msg "lookup of $lang:$stripped_name returned $id, default-lang([my name])=$default_lang [my nls_language]" + if {$id != 0} { + # The instance exists already + return [$package_id returnredirect \ + [export_vars -base [$package_id pretty_link -parent_id $parent_id $lang:$stripped_name] \ + [list return_url template_file]]] + } else { + if {$lang ne $default_lang} { + set nls_language [my get_nls_language_from_lang $lang] + } else { + set nls_language [my nls_language] + } + #my msg "We want to create $lang:$stripped_name" + return [next -name $lang:$stripped_name -nls_language $nls_language] + } + } + } + next + } + + WorkflowPage instproc initialize_loaded_object {} { + next + if {[my is_wf_instance]} { + my initialize + } + } + + WorkflowPage instproc initialize {} { + #my log "is_wf_instance [my is_wf_instance]" + # + # A fresh workflow page was created (called only once per + # workflow page at initial creation) + # + if {[my is_wf_instance]} { + # + # Get context and call user defined "constructor" + # + set ctx [::xowf::Context require [self]] + my activate -verbose false $ctx initialize + + # Ignore the returned next_state, since the initial state is + # always set to the same value from the ctx (initial) + #my msg "[self] is=[my set instance_attributes]" + } + next + + } + + WorkflowPage instproc default_instance_attributes {} { + # Provide the default list of instance attributes to derived + # FormPages. + if {[my is_wf]} { + # + # We have a workflow page. Get the initial state of the workflow + # instance from the workflow. + # + my instvar instance_attributes + set ctx [::xowf::Context require [self]] + foreach p [$ctx defined ::xowiki::formfield::FormField] { + set name [$p name] + set value [$p default] + if {[::xo::cc exists_query_parameter $name]} { + # never clobber instance attributes from query parameters blindly + #my msg "ignore $name" + continue + } + if {[::xo::cc exists_query_parameter p.$name] + && [$p exists allow_query_parameter]} { + # we allow the value to be taken from the query parameter + set value [::xo::cc query_parameter p.$name] + } + dict set instance_attributes $name $value + set f($name) $p + } + + ## save instance attributes + #set instance_attributes [array get __ia] + #my msg "[self] [my name] setting default parameter" + #my msg ia=$instance_attributes,props=[$ctx defined Property] + + my state [$ctx get_current_state] + #my msg "setting initial state to '[my state]'" + + return $instance_attributes + } else { + next + } + } + WorkflowPage instproc constraints_as_array {c} { + array set __c "" + foreach name_and_spec $c { + regexp {^([^:]+):(.*)$} $name_and_spec _ spec_name short_spec + set __c($spec_name) $short_spec + } + return [array get __c] + } + WorkflowPage instproc merge_constraints {c1 args} { + # Load into the base_constraints c1 the constraints from the argument list. + # The first constraints have the lowest priority + array set __c1 [my constraints_as_array $c1] + foreach c2 $args { + foreach {att value} [my constraints_as_array $c2] { + set key __c1($att) + if {[info exists $key]} {append $key ",$value"} else {set $key $value} + } + } + set result [list] + foreach {att value} [array get __c1] {lappend result $att:$value} + return $result + } + WorkflowPage instproc wfi_merged_form_constraints {constraints_from_form} { + set ctx [::xowf::Context require [self]] + set wf_specific_constraints [[my page_template] property form_constraints] + set m [my merge_constraints $wf_specific_constraints \ + $constraints_from_form [$ctx get_form_constraints]] + #my msg "merged:$m" + return $m + } + WorkflowPage instproc wf_merged_form_constraints {constraints_from_form} { + return $constraints_from_form + #return [my merge_constraints $constraints_from_form [my property form_constraints]] + } + + WorkflowPage instproc get_anon_instances {} { + if {[my istype ::xowiki::FormPage] && [my is_wf_instance]} { + # In case, the workflow has the autoname variable set, it has + # the highest weight of all other sources. + set ctx [::xowf::Context require [self]] + if {[$ctx exists autoname]} { + return [$ctx set autoname] + } + } + next + } + + WorkflowPage instproc get_form_constraints {{-trylocal false}} { + if {[my istype ::xowiki::FormPage] && [my is_wf]} { + #my msg "get_form_constraints is_wf" + return [::xo::cc cache [list [self] wf_merged_form_constraints [next]]] + } elseif {[my istype ::xowiki::FormPage] && [my is_wf_instance]} { + #my msg "get_form_constraints is_wf_instance" + return [::xo::cc cache [list [self] wfi_merged_form_constraints [next]]] + } else { + #my msg "get_form_constraints next" + next + } + } + WorkflowPage instproc visited_states {} { + my instvar item_id + foreach state [xo::dc list history { + select DISTINCT state from xowiki_form_page p, cr_items i, cr_revisions r + where i.item_id = :item_id and r.item_id = i.item_id and xowiki_form_page_id = r.revision_id}] { + set visited($state) 1 + } + #my msg "visisted states of item $item_id = [array names visited]" + return [array names visited] + } + + WorkflowPage ad_instproc footer {} { + Provide a tailored footer for workflow definition pages and + workflow instance pages containing controls for instantiating + forms or providing links to the workflow definition. + } { + if {[my exists __no_form_page_footer]} { + next + } else { + my instvar package_id + set form_item_id [my page_template] + #my msg "is wf page [my is_wf], is wf instance page [my is_wf_instance]" + if {[my is_wf]} { + # + # page containing a work flow definition + # + #set ctx [::xowf::Context require [self]] + set work_flow_form [::xo::db::CrClass get_instance_from_db -item_id $form_item_id] + set work_flow_base [$work_flow_form pretty_link] + + set wf [self] + set wf_base [$wf pretty_link] + set button_objs [list] + + # create new workflow instance button with start form + if {[my parent_id] != [$package_id folder_id]} { + set parent_id [my parent_id] + } + set link [$package_id make_link -link $wf_base $wf create-new parent_id return_url] + lappend button_objs [::xowiki::includelet::form-menu-button-new new -volatile \ + -parent_id [my parent_id] \ + -form $wf -link $link] + + # list workflow instances button + set obj [::xowiki::includelet::form-menu-button-wf-instances new -volatile \ + -package_id $package_id -parent_id [my parent_id] \ + -base $wf_base -form $wf] + if {[info exists return_url]} {$obj return_url $return_url} + lappend button_objs $obj + + # work flow definition button + set obj [::xowiki::includelet::form-menu-button-form new -volatile \ + -package_id $package_id -parent_id [my parent_id] \ + -base $work_flow_base -form $work_flow_form] + if {[info exists return_url]} {$obj return_url $return_url} + lappend button_objs $obj + + # make menu + return [my include [list form-menu -form_item_id [my item_id] -button_objs $button_objs]] + + } elseif {[my is_wf_instance]} { + # + # work flow instance + # + set entry_form_item_id [my wf_property wf_form_id] + set work_flow_form [::xo::db::CrClass get_instance_from_db -item_id $form_item_id] + set work_flow_base [$work_flow_form pretty_link] + set button_objs [list] + + #my msg entry_form_item_id=$entry_form_item_id-exists?=[my isobject $entry_form_item_id] + + # form definition button + if {![my isobject $entry_form_item_id]} { + # In case, the id is a form object, it is a dynamic form, + # that we can't edit; therefore, we provide no link. + # + # Here, we have have an id that we use for fetching... + # + set form [::xo::db::CrClass get_instance_from_db -item_id $entry_form_item_id] + set base [$form pretty_link] + set obj [::xowiki::includelet::form-menu-button-form new -volatile \ + -package_id $package_id -parent_id [my parent_id] \ + -base $base -form $form] + if {[info exists return_url]} {$obj return_url $return_url} + lappend button_objs $obj + } + + # if {[my exists_property form]} { + # lappend button_objs \ + # [::xowiki::includelet::form-menu-button-new new -volatile \ + # -package_id $package_id -parent_id [my parent_id] \ + # -base [my pretty_link] -form [self]] + # lappend button_objs \ + # [::xowiki::includelet::form-menu-button-answers new -volatile \ + # -package_id $package_id -parent_id [my parent_id] \ + # -base [my pretty_link] -form [self]] + # } + # work flow definition button + set obj [::xowiki::includelet::form-menu-button-wf new -volatile \ + -package_id $package_id -parent_id [my parent_id] \ + -base $work_flow_base -form $work_flow_form] + if {[info exists return_url]} {$obj return_url $return_url} + lappend button_objs $obj + # make menu + return [my include [list form-menu -form_item_id [my page_template] -button_objs $button_objs]] + } else { + #return [my include [list form-menu -form_item_id $form_item_id -buttons form]] + next + } + } + } + + WorkflowPage ad_instproc call_action_foreach {-action:required {-attributes ""} page_names} { + Call the specified action for each of the specified pages denoted + by the list of page names + } { + foreach page_name $page_names { + set page [[my package_id] get_page_from_name -parent_id [my parent_id] -name $page_name] + if {$page ne ""} { + $page call_action -action $action -attributes $attributes + } else { + ns_log notice "WF: could not call action $action, since $page_name in [my parent_id] failed" + } + } + } + + + WorkflowPage ad_instproc call_action {-action {-attributes {}}} { + Call the specified action in the current workflow instance. + The specified attributes are provided like form_parameters to + the action of the workflow. + } { + my instvar package_id + if {![my is_wf_instance]} { + error "Page [self] is not a Workflow Instance" + } + set ctx [::xowf::Context require [self]] + my log "CTX of [self] ([my name])= $ctx" + foreach a [$ctx get_actions] { + if {[namespace tail $a] eq "$action"} { + # In the current state, the specified action is allowed + my log "--xowf action $action allowed -- name='[my name]'" + return [$a invoke -attributes $attributes] + } + } + set a ${ctx}::$action + if {[info commands $a] ne "" && [$a state_safe]} { + # The action is defined as state-safe, so if can be called in every state + my log "--xowf action $action state_safe -- name='[my name]'" + return [$a invoke -attributes $attributes] + } + error "\tNo state-safe action '$action' available in workflow instance [self] of \ + [[my page_template] name] in state [$ctx get_current_state] + Available actions: [[$ctx current_state] get_actions]" + } + + # + # Interface to atjobs + # + WorkflowPage ad_instproc schedule_action {-time -party_id -action {-attributes {}}} { + Schedule the specified action for the current workflow instance at the given + time. The specified attributes are provided like form_parameters to + the action of the workflow. + } { + my instvar package_id + if {![my is_wf_instance]} { + error "Page [self] is not a Workflow Instance" + } + if {![info exists party_id]} {set party_id [::xo::cc user_id]} + my schedule_job -time $time -party_id $party_id \ + [list call_action -action $action -attributes $attributes] + } + + WorkflowPage ad_instproc schedule_job {-time:required -party_id cmd} { + Schedule the specified tcl command for the the current package + instance at the given time. + } { + my instvar package_id + my log "-at" + set j [::xowf::atjob new -time $time -party_id $party_id -cmd $cmd -object [self]] + $j persist + } + + ad_proc migrate_from_wf_current_state {} { + # + # Transform the former instance_attributes + # "wf_current_state" to the xowiki::FormPage attribute "state", and + # "wf_assignee" to the xowiki::FormPage attribute "assignee". + # + set count 0 + foreach atts [xo::dc list_of_lists entries { + select p.state,p.assignee,pi.instance_attributes,p.xowiki_form_page_id + from xowiki_form_page p, xowiki_page_instance pi, cr_items i, cr_revisions r + where r.item_id = i.item_id and p.xowiki_form_page_id = r.revision_id and + pi.page_instance_id = r.revision_id + }] { + lassign $atts state assignee instance_attributes xowiki_form_page_id + if {[dict exists $instance_attributes wf_current_state] + && [dict get $instance_attributes wf_current_state] ne $state} { + #Object msg "must update state $state for $xowiki_form_page_id to [dict get $instance_attributes wf_current_state]" + + xo::db dml update_state "update xowiki_form_page \ + set state = '[dict get $instance_attributes wf_current_state]' + where xowiki_form_page_id = :xowiki_form_page_id" + incr count + } + if {[dict exists $instance_attributes wf_assignee] && [dict get $instance_attributes wf_assignee] ne $assignee} { + #Object msg "must update assignee $assignee for $xowiki_form_page_id to [dict get $instance_attributes wf_assignee]" + set wf_assignee [dict get $instance_attributes wf_assignee] + xo::dc dml update_state "update xowiki_form_page set assignee = :wf_assignee \ + where xowiki_form_page_id = :xowiki_form_page_id" + incr count + } + } + return $count + } + + ad_proc update_hstore {package_id} { + update all instance attributes in hstore + } { + if {![::xo::dc has_hstore] && [$package_id get_parameter use_hstore 0] } {return 0} + # + # This proc can be used from ds/shell as follows + # + # ::xowf::Package initialize -url /xowf + # ::xowf::update_hstore $package_id + # + # Check the result + # + # select hkey from xowiki_page_instance where hkey is not null; + # + ::xowf::Package initialize -package_id $package_id + # + # we get all revisions, so use the lower level interface + # + set items [::xowiki::FormPage instantiate_objects \ + -sql "select * from xowiki_form_pagei bt,cr_items i \ + where bt.object_package_id = $package_id and bt.item_id = i.item_id" \ + -object_class ::xowiki::FormPage] + set count 0 + foreach i [$items children] { + #$i msg "working on [$i set xowiki_form_page_id]" + $i save_in_hstore + incr count + } + $items msg "fetched $count objects from parent_id [$package_id folder_id]" + return 1 + } + + # Some example hstore queries (over all revisions) + # select hkey from xowiki_page_instance where hkey is not null; + # select hkey from xowiki_page_instance where defined(hkey, 'team_email'); + # select hkey from xowiki_page_instance where exist(hkey, 'team_email'); + # select hkey from xowiki_page_instance where 'team_email=>neumann@wu-wien.ac.at' <@ hkey; + # select (each(hkey)).key, (each(hkey)).value from xowiki_page_instance; + # select page_instance_id, (each(hkey)).key, (each(hkey)).value from xowiki_page_instance + # where 'assignee=>539,priority=>1' <@ hkey; + # select key, count(*) from (select (each(hkey)).key from xowiki_page_instance) as stat + # group by key order by count desc, key; + # + +} + + + +# +# In order to provide either a REST or a DAV interface, we have to +# switch to basic authentication, since non-openacs packages +# have problems to handle openacs coockies. The basic authentication +# interface can be establised in three steps: +# +# 1) Create a basic authentication handler, Choose a URL and +# define optionally the package to be initialized: +# Example: +# ::xowf::dav create ::xowf::ba -url /ba -package ::xowf::Package +# +# 2) Make sure, the basic authenication handler is initialied during +# startup. Write an -init.tcl file containing a call to the +# created handler. +# Example: +# ::xowf::ba register +# +# 3) Write procs with names such as GET, PUT, POST to handle +# the requests. These procs overload the predefined behavior. +# + +namespace eval ::xowf { + # ::xo::dav should be probably changed to ::xo::ProtocolHandler for release + ::xotcl::Class create ::xowf::dav -superclass ::xo::dav + + ::xowf::dav instproc get_package_id {} { + my instvar uri package wf package_id + if {$uri eq "/"} { + # Take the first package instance + set wf "" + set package_id [lindex [$package instances] 0] + $package initialize -package_id $package_id + } else { + set wf /$uri + $package initialize -url $uri + } + # my log package_id=$package_id + return $package_id + } + + ::xowf::dav instproc call_action {-uri -action -attributes} { + [my package] initialize -url $uri + set object_name [$package_id set object] + set page [$package_id resolve_request -path $object_name method] + if {$page eq ""} { + set errorMsg cannot resolve '$object_name' in package [$package_id package_url] + my log "Error: $errorMsg" + ns_return 406 text/plain "Error: $errorMsg" + } elseif {[catch {set msg [$page call_action \ + -action $action \ + -attributes $attributes]} errorMsg]} { + my log "Error: $uri $action $attributes resulted in\n$errorMsg\n$::errorInfo" + ns_return 406 text/plain "Error: $errorMsg\n" + } else { + ns_return 200 text/plain "Success: $msg\n" + } + } + + + ::xowf::dav create ::xowf::dav-todo -url /dav-todo -package ::xowf::Package + + ::xowf::dav-todo proc GET {} { + my instvar uri wf package_id + set p [::xowiki::Page new -package_id $package_id] + $p include [list wf-todo -ical 1 -workflow $wf] + #ns_return 200 text/plain GET-$uri-XXX-pid=$package_id-wf=$wf-[::xo::cc serialize] + } + + # ::xowf::dav-todo proc GET {} { + # set uri /xowf/153516 + # set uri /xowf/18362 + # set uri /xowf/18205 + # my call_action -uri $uri -action work -attributes [list comment hello3 effort 4] + # } + + proc include {wfName {vars ""}} { + uplevel [::xowf::include_get -level 2 $wfName {*}$vars] + } + + ad_proc include_get {{-level 1} wfName {vars ""}} { + if {![string match "/packages/*/lib/*" $wfName]} { + error "path leading to workflow name must look likw /packages/*/lib/*" + } + set fname [get_server_root]$wfName + + if {![file readable $fname]} { + error "file '$fname' not found" + } + set f [open $fname]; set wfDefinition [read $f]; close $f + #::xotcl::Object log "INCLUDE $wfName [list $vars]" + if {[llength $vars] > 0} { + foreach var $vars { + lappend substMap @$var@ [uplevel $level [list set $var]] + } + set wfDefinition [string map $substMap $wfDefinition] + } + #::xotcl::Object log "AFTER SUBST $wfName [list $vars]\n$wfDefinition" + return [list eval $wfDefinition] + } + +} + +::xo::library source_dependent + +# +# Local variables: +# mode: tcl +# tcl-indent-level: 2 +# indent-tabs-mode: nil +# End: Index: openacs-4/packages/xowf/www/index.vuh =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/xowf/www/index.vuh,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/xowf/www/index.vuh 28 Aug 2014 08:24:56 -0000 1.1 @@ -0,0 +1,20 @@ +# -*- tcl -*- +::xowf::Package initialize -ad_doc { + + This is the resolver for this package. It turns a request into + an object and executes the object with the computed method + + @author Gustaf Neumann (gustaf.neumann@wu-wien.ac.at) + @creation-date July, 2006 + @cvs-id $Id: index.vuh,v 1.1 2014/08/28 08:24:56 gustafn Exp $ + +} -parameter { + {-m view} + {-folder_id:integer 0} +} +# body=[ns_conn content] +::$package_id log "--starting... [ns_conn url] [ns_conn query] \n\ + form vars = [ns_set array [ns_getform]]" +::$package_id reply_to_user [::$package_id invoke -method $m] +::$package_id log "--i ::$package_id DONE" +ad_script_abort Index: openacs-4/packages/xowf/www/admin/index.vuh =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/xowf/www/admin/index.vuh,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/xowf/www/admin/index.vuh 28 Aug 2014 08:24:57 -0000 1.1 @@ -0,0 +1,5 @@ +# -*- tcl -*- +::xowf::Package initialize +set l [expr {[lsearch -exact [ns_conn urlv] admin] + 1 }] +set path [join [lrange [ns_conn urlv] $l end] /] +rp_internal_redirect /packages/xowiki/www/admin/$path Index: openacs-4/packages/xowf/www/prototypes/atjob-form.page =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/xowf/www/prototypes/Attic/atjob-form.page,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/xowf/www/prototypes/atjob-form.page 28 Aug 2014 08:24:57 -0000 1.1 @@ -0,0 +1,18 @@ +# -*- tcl-*- +::xowiki::Form new \ + -set name en:atjob-form \ + -title "At-Job Form" \ + -set anon_instances t \ + -set text {} \ + -set form {{} text/html} \ + -set form_constraints { +_page_order:hidden _creator:hidden +_title:text,label=#acs-kernel.common_Title# +{_publish_date:date,format=DD_MONTH_YYYY_HH24_MI,label=Scheduled execution time} +{_publish_status:radio,options={waiting production} {done expired},label=Status} +@table_properties:publish_status=all +@table:_name,_publish_status,_last_modified + } + + + Index: openacs-4/packages/xowf/www/prototypes/index.page =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/xowf/www/prototypes/index.page,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/xowf/www/prototypes/index.page 28 Aug 2014 08:24:57 -0000 1.1 @@ -0,0 +1,27 @@ +::xowiki::Page new -title "Index Page" -text { + +
+This is the default start page of XoWiki. You can edit this page and save it to provide a personalized look of the XoWiki instance. You can as well provide a different index page through configuration. +You can also view the contents of the Wiki in a weblog style. +For more details, consult the [[http://media.wu-wien.ac.at/download/xowiki-doc/|XoWiki documentation]]. +
++A user can define notifications +for the whole XoWiki instance (by clicking on the notifications button +in the menu bar or for categories (by clicking on the letter symbol +next to the category entries at the bottom of the page) +
+>>left-col<< +{{recent -max_entries 25}} +>><< +>>right-col<< +{{last-visited -title "Last Visited" -max_entries 10 }} ++{{most-popular -title "Most Popular" -max_entries 10 }} +>><< + +} + + + + Index: openacs-4/packages/xowf/www/resources/feedback.css =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/xowf/www/resources/feedback.css,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/xowf/www/resources/feedback.css 28 Aug 2014 08:24:57 -0000 1.1 @@ -0,0 +1,7 @@ +/* .xowiki-content .correct:after {content: " -- ok";}*/ +form.feedback .correct {border: 1px dotted green; background-color: #aaffaa;} + +/* .xowiki-content .incorrect:after {content: "-- wrong";}*/ +form.feedback .incorrect {border: 1px dotted red; background-color: #ffaaaa;} + +form.feedback div.form-required-mark {display:none;} \ No newline at end of file Index: openacs-4/packages/xowf/www/resources/myform.css =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/xowf/www/resources/Attic/myform.css,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/xowf/www/resources/myform.css 28 Aug 2014 08:24:57 -0000 1.1 @@ -0,0 +1,11 @@ +.xowiki-content fieldset { + border: 1px solid #ccc; +} +.xowiki-content .margin-form fieldset .form-item-wrapper .form-label { + width: 10em; +} +.xowiki-content .margin-form fieldset .form-item-wrapper .form-widget, +.xowiki-content .margin-form fieldset .form-button, +.xowiki-content .margin-form fieldset div.form-help-text { + margin-left: 11em; +} \ No newline at end of file