Fisheye: Tag 1.8 refers to a dead (removed) revision in file `openacs-4/contrib/packages/simulation/tcl/action-procs.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.11 refers to a dead (removed) revision in file `openacs-4/contrib/packages/simulation/tcl/role-procs.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Index: openacs-4/contrib/packages/simulation/tcl/sim-action-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/simulation/tcl/Attic/sim-action-procs.tcl,v
diff -u
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/contrib/packages/simulation/tcl/sim-action-procs.tcl 17 Dec 2003 14:05:22 -0000 1.1
@@ -0,0 +1,286 @@
+ad_library {
+ API for Simulation actions.
+
+ @author Lars Pind (lars@collaboraid.biz)
+ @creation-date 2003-10-14
+ @cvs-id $Id: sim-action-procs.tcl,v 1.1 2003/12/17 14:05:22 lars Exp $
+}
+
+namespace eval simulation::action {}
+
+ad_proc -public simulation::action::edit {
+ {-operation "update"}
+ {-action_id {}}
+ {-workflow_id {}}
+ {-array {}}
+ {-internal:boolean}
+} {
+ Edit an action.
+
+ @param operation insert, update, delete
+
+ @param action_id For update/delete: The action to update or delete.
+ For insert: Optionally specify a pre-generated action_id for the action.
+
+ @param workflow_id For update/delete: Optionally specify the workflow_id. If not specified, we will execute a query to find it.
+ For insert: The workflow_id of the new action.
+
+ @param array For insert/update: Name of an array in the caller's namespace with attributes to insert/update.
+
+ @param internal Set this flag if you're calling this proc from within the corresponding proc
+ for a particular workflow model. Will cause this proc to not flush the cache
+ or call workflow::definition_changed_handler, which the caller must then do.
+
+ @return action_id
+
+ @see workflow::action::fsm::edit
+} {
+ switch $operation {
+ update - delete {
+ if { [empty_string_p $action_id] } {
+ error "You must specify the action_id of the action to $operation."
+ }
+ }
+ insert {}
+ default {
+ error "Illegal operation '$operation'"
+ }
+ }
+ switch $operation {
+ insert - update {
+ upvar 1 $array org_row
+ if { ![array exists org_row] } {
+ error "Array $array does not exist or is not an array"
+ }
+ array set row [array get org_row]
+ }
+ }
+ switch $operation {
+ insert {
+ if { [empty_string_p $workflow_id] } {
+ error "You must supply workflow_id"
+ }
+ }
+ update - delete {
+ if { [empty_string_p $workflow_id] } {
+ set workflow_id [workflow::action::get_element \
+ -action_id $action_id \
+ -element workflow_id]
+ }
+ }
+ }
+
+ # Parse column values
+ switch $operation {
+ insert - update {
+ # Special-case: array entry recipient_role (short_name) and recipient (state_id) -- DB column is recipient (state_id)
+ if { [info exists row(recipient_role)] } {
+ if { [info exists row(role)] } {
+ error "You cannot supply both recipient_role (takes short_name) and recipient (takes state_id)"
+ }
+ if { [empty_string_p $row(recipient_role)] } {
+ set row(recipient) [db_null]
+ } else {
+ # Get role_id by short_name
+ set row(recipient) [workflow::role::get_id \
+ -workflow_id $workflow_id \
+ -short_name $row(recipient_role)]
+ }
+ unset row(recipient_role)
+ }
+
+ set update_clauses [list]
+ set insert_names [list]
+ set insert_values [list]
+
+ # Handle columns in the sim_tasks table
+ foreach attr {
+ recipient attachment_num
+ } {
+ if { [info exists row($attr)] } {
+ set varname attr_$attr
+ # Convert the Tcl value to something we can use in the query
+ switch $attr {
+ default {
+ set $varname $row($attr)
+ }
+ }
+ # Add the column to the insert/update statement
+ switch $attr {
+ default {
+ lappend update_clauses "$attr = :$varname"
+ lappend insert_names $attr
+ lappend insert_values :$varname
+ }
+ }
+ unset row($attr)
+ }
+ }
+ }
+ }
+
+ db_transaction {
+ # Base row
+ set action_id [workflow::action::fsm::edit \
+ -internal \
+ -operation $operation \
+ -action_id $action_id \
+ -workflow_id $workflow_id \
+ -array row]
+
+ # sim_tasks row
+ switch $operation {
+ insert {
+ lappend insert_names task_id
+ lappend insert_values :action_id
+
+ db_dml insert_action "
+ insert into sim_tasks
+ ([join $insert_names ", "])
+ values
+ ([join $insert_values ", "])
+ "
+ }
+ update {
+ if { [llength $update_clauses] > 0 } {
+ db_dml update_action "
+ update sim_tasks
+ set [join $update_clauses ", "]
+ where task_id = :action_id
+ "
+ }
+ }
+ delete {
+ # Handled through cascading delete
+ }
+ }
+
+ if { !$internal_p } {
+ workflow::definition_changed_handler -workflow_id $workflow_id
+ }
+ }
+
+ if { !$internal_p } {
+ workflow::flush_cache -workflow_id $workflow_id
+ }
+
+ return $action_id
+}
+
+
+ad_proc -public simulation::action::get {
+ {-local_only:boolean}
+ {-action_id:required}
+ {-array:required}
+} {
+ Get information about a simulation action.
+
+ @param local_only Set this to only get the attributes from the simulation extension table,
+ not the ones derived from workflow::action::fsm.
+} {
+ upvar 1 $array row
+
+ if { !$local_only_p } {
+ workflow::action::fsm::get -action_id $action_id -array row
+ }
+
+ db_1row select_action {
+ select recipient,
+ (select short_name
+ from workflow_roles
+ where role_id = recipient) as recipient_role,
+ attachment_num
+ from sim_tasks
+ where task_id = :action_id
+ } -column_array local_row
+
+ array set row [array get local_row]
+}
+
+
+ad_proc -private simulation::action::generate_spec {
+ {-action_id {}}
+ {-one_id {}}
+} {
+ Generate the spec for an individual simulation task definition.
+
+ @param action_id The id of the action to generate spec for.
+
+ @param one_id Same as action_id, just used for consistency across roles/actions/states.
+
+ @return spec The actions spec
+
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ if { [empty_string_p $action_id] } {
+ if { [empty_string_p $one_id] } {
+ error "You must supply either action_id or one_id"
+ }
+ set action_id $one_id
+ } else {
+ if { ![empty_string_p $one_id] } {
+ error "You can only supply either action_id or one_id"
+ }
+ }
+
+ set spec [workflow::action::fsm::generate_spec -action_id $action_id]
+
+ get -action_id $action_id -array row -local_only
+
+ array unset row recipient
+
+ foreach name [lsort [array names row]] {
+ if { ![empty_string_p $row($name)] } {
+ lappend spec $name $row($name)
+ }
+ }
+
+ return $spec
+}
+
+ad_proc -public simulation::action::get_ids {
+ {-workflow_id:required}
+} {
+ Get the action_id's of all the actions in the workflow.
+
+ @param workflow_id The ID of the workflow
+
+ @return list of action_id's.
+
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ return [workflow::action::fsm::get_ids -workflow_id $workflow_id]
+}
+
+ad_proc -public simulation::action::get_element {
+ {-action_id {}}
+ {-one_id {}}
+ {-element:required}
+} {
+ Return element from information about an action with a given id, including
+ simulation info.
+
+ @param action_id The ID of the action
+
+ @param one_id Same as action_id, just used for consistency across roles/actions/states.
+
+ @param element The element you want
+
+ @return The element you asked for
+
+ @author Peter Marklund
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ if { [empty_string_p $action_id] } {
+ if { [empty_string_p $one_id] } {
+ error "You must supply either action_id or one_id"
+ }
+ set action_id $one_id
+ } else {
+ if { ![empty_string_p $one_id] } {
+ error "You can only supply either action_id or one_id"
+ }
+ }
+ get -action_id $action_id -array row
+ return $row($element)
+}
Index: openacs-4/contrib/packages/simulation/tcl/sim-role-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/simulation/tcl/Attic/sim-role-procs.tcl,v
diff -u
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/contrib/packages/simulation/tcl/sim-role-procs.tcl 17 Dec 2003 14:05:22 -0000 1.1
@@ -0,0 +1,260 @@
+ad_library {
+ API for Simulation roles.
+
+ @author Lars Pind (lars@collaboraid.biz)
+ @creation-date 2003-10-14
+ @cvs-id $Id: sim-role-procs.tcl,v 1.1 2003/12/17 14:05:22 lars Exp $
+}
+
+namespace eval simulation::role {}
+
+ad_proc -public simulation::role::edit {
+ {-operation "update"}
+ {-role_id {}}
+ {-workflow_id {}}
+ {-array {}}
+ {-internal:boolean}
+} {
+ Edit a role.
+
+ @param operation insert, update, delete
+
+ @param role_id For update/delete: The role to update or delete.
+ For insert: Optionally specify a pre-generated role_id for the role.
+
+ @param workflow_id For update/delete: Optionally specify the workflow_id. If not specified, we will execute a query to find it.
+ For insert: The workflow_id of the new role.
+
+ @param array For insert/update: Name of an array in the caller's namespace with attributes to insert/update.
+
+ @param internal Set this flag if you're calling this proc from within the corresponding proc
+ for a particular workflow model. Will cause this proc to not flush the cache
+ or call workflow::definition_changed_handler, which the caller must then do.
+
+ @return role_id
+
+ @see workflow::role::fsm::edit
+} {
+ switch $operation {
+ update - delete {
+ if { [empty_string_p $role_id] } {
+ error "You must specify the role_id of the role to $operation."
+ }
+ }
+ insert {}
+ default {
+ error "Illegal operation '$operation'"
+ }
+ }
+ switch $operation {
+ insert - update {
+ upvar 1 $array org_row
+ if { ![array exists org_row] } {
+ error "Array $array does not exist or is not an array"
+ }
+ array set row [array get org_row]
+ }
+ }
+ switch $operation {
+ insert {
+ if { [empty_string_p $workflow_id] } {
+ error "You must supply workflow_id"
+ }
+ }
+ update {
+ if { [empty_string_p $workflow_id] } {
+ set workflow_id [workflow::role::get_element \
+ -role_id $role_id \
+ -element workflow_id]
+ }
+ }
+ }
+
+ # Parse column values
+ switch $operation {
+ insert - update {
+ set update_clauses [list]
+ set insert_names [list]
+ set insert_values [list]
+
+ # Handle columns in the sim_tasks table
+ foreach attr {
+ character_id
+ } {
+ if { [info exists row($attr)] } {
+ set varname attr_$attr
+ # Convert the Tcl value to something we can use in the query
+ switch $attr {
+ default {
+ set $varname $row($attr)
+ }
+ }
+ # Add the column to the insert/update statement
+ switch $attr {
+ default {
+ lappend update_clauses "$attr = :$varname"
+ lappend insert_names $attr
+ lappend insert_values :$varname
+ }
+ }
+ unset row($attr)
+ }
+ }
+ }
+ }
+
+ db_transaction {
+ # Base row
+ set role_id [workflow::role::edit \
+ -internal \
+ -operation $operation \
+ -role_id $role_id \
+ -workflow_id $workflow_id \
+ -array row]
+
+ # sim_roles row
+ switch $operation {
+ insert {
+ lappend insert_names role_id
+ lappend insert_values :role_id
+
+ db_dml insert_role "
+ insert into sim_roles
+ ([join $insert_names ", "])
+ values
+ ([join $insert_values ", "])
+ "
+ }
+ update {
+ if { [llength $update_clauses] > 0 } {
+ db_dml update_role "
+ update sim_roles
+ set [join $update_clauses ", "]
+ where role_id = :role_id
+ "
+ }
+ }
+ delete {
+ # Handled through cascading delete
+ }
+ }
+
+ if { !$internal_p } {
+ workflow::definition_changed_handler -workflow_id $workflow_id
+ }
+ }
+
+ if { !$internal_p } {
+ workflow::flush_cache -workflow_id $workflow_id
+ }
+
+ return $role_id
+}
+
+ad_proc -public simulation::role::get {
+ {-local_only:boolean}
+ {-role_id:required}
+ {-array:required}
+} {
+ Get information about a simulation role
+
+ @param local_only Set this to only get the attributes from the simulation extension table,
+ not the ones derived from workflow::role
+} {
+ upvar 1 $array row
+
+ if { !$local_only_p } {
+ workflow::role::get -role_id $role_id -array row
+ }
+
+ db_1row select_sim_role {
+ select role_id,
+ character_id
+ from sim_roles
+ where role_id = :role_id
+ } -column_array local_row
+
+ array set row [array get local_row]
+}
+
+ad_proc -public simulation::role::get_element {
+ {-role_id {}}
+ {-one_id {}}
+ {-element:required}
+} {
+ Return a single element from the information about a role.
+
+ @param role_id The id of the role to get an element for.
+
+ @param one_id Same as role_id, just used for consistency across roles/actions/states.
+
+ @return element The element you asked for
+
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ if { [empty_string_p $role_id] } {
+ if { [empty_string_p $one_id] } {
+ error "You must supply either role_id or one_id"
+ }
+ set role_id $one_id
+ } else {
+ if { ![empty_string_p $one_id] } {
+ error "You can only supply either role_id or one_id"
+ }
+ }
+
+ get -role_id $role_id -array row
+ return $row($element)
+}
+
+ad_proc -private simulation::role::get_ids {
+ {-workflow_id:required}
+} {
+ Get the IDs of all the roles in the right order.
+
+ @param workflow_id The id of the workflow to delete.
+
+ @return A list of role IDs.
+
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ return [workflow::role::get_ids -workflow_id $workflow_id]
+}
+
+ad_proc -private simulation::role::generate_spec {
+ {-role_id {}}
+ {-one_id {}}
+} {
+ Generate the spec for an individual simulation task definition.
+
+ @param role_id The id of the role to generate spec for.
+
+ @param one_id Same as role_id, just used for consistency across roles/roles/states.
+
+ @return spec The roles spec
+
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ if { [empty_string_p $role_id] } {
+ if { [empty_string_p $one_id] } {
+ error "You must supply either role_id or one_id"
+ }
+ set role_id $one_id
+ } else {
+ if { ![empty_string_p $one_id] } {
+ error "You can only supply either role_id or one_id"
+ }
+ }
+
+ set spec [workflow::role::generate_spec -role_id $role_id]
+
+ get -role_id $role_id -array row -local_only
+
+ foreach name [lsort [array names row]] {
+ if { ![empty_string_p $row($name)] } {
+ lappend spec $name $row($name)
+ }
+ }
+
+ return $spec
+}
Fisheye: Tag 1.8 refers to a dead (removed) revision in file `openacs-4/packages/simulation/tcl/action-procs.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.11 refers to a dead (removed) revision in file `openacs-4/packages/simulation/tcl/role-procs.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Index: openacs-4/packages/simulation/tcl/sim-action-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/simulation/tcl/sim-action-procs.tcl,v
diff -u
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/packages/simulation/tcl/sim-action-procs.tcl 17 Dec 2003 14:05:22 -0000 1.1
@@ -0,0 +1,286 @@
+ad_library {
+ API for Simulation actions.
+
+ @author Lars Pind (lars@collaboraid.biz)
+ @creation-date 2003-10-14
+ @cvs-id $Id: sim-action-procs.tcl,v 1.1 2003/12/17 14:05:22 lars Exp $
+}
+
+namespace eval simulation::action {}
+
+ad_proc -public simulation::action::edit {
+ {-operation "update"}
+ {-action_id {}}
+ {-workflow_id {}}
+ {-array {}}
+ {-internal:boolean}
+} {
+ Edit an action.
+
+ @param operation insert, update, delete
+
+ @param action_id For update/delete: The action to update or delete.
+ For insert: Optionally specify a pre-generated action_id for the action.
+
+ @param workflow_id For update/delete: Optionally specify the workflow_id. If not specified, we will execute a query to find it.
+ For insert: The workflow_id of the new action.
+
+ @param array For insert/update: Name of an array in the caller's namespace with attributes to insert/update.
+
+ @param internal Set this flag if you're calling this proc from within the corresponding proc
+ for a particular workflow model. Will cause this proc to not flush the cache
+ or call workflow::definition_changed_handler, which the caller must then do.
+
+ @return action_id
+
+ @see workflow::action::fsm::edit
+} {
+ switch $operation {
+ update - delete {
+ if { [empty_string_p $action_id] } {
+ error "You must specify the action_id of the action to $operation."
+ }
+ }
+ insert {}
+ default {
+ error "Illegal operation '$operation'"
+ }
+ }
+ switch $operation {
+ insert - update {
+ upvar 1 $array org_row
+ if { ![array exists org_row] } {
+ error "Array $array does not exist or is not an array"
+ }
+ array set row [array get org_row]
+ }
+ }
+ switch $operation {
+ insert {
+ if { [empty_string_p $workflow_id] } {
+ error "You must supply workflow_id"
+ }
+ }
+ update - delete {
+ if { [empty_string_p $workflow_id] } {
+ set workflow_id [workflow::action::get_element \
+ -action_id $action_id \
+ -element workflow_id]
+ }
+ }
+ }
+
+ # Parse column values
+ switch $operation {
+ insert - update {
+ # Special-case: array entry recipient_role (short_name) and recipient (state_id) -- DB column is recipient (state_id)
+ if { [info exists row(recipient_role)] } {
+ if { [info exists row(role)] } {
+ error "You cannot supply both recipient_role (takes short_name) and recipient (takes state_id)"
+ }
+ if { [empty_string_p $row(recipient_role)] } {
+ set row(recipient) [db_null]
+ } else {
+ # Get role_id by short_name
+ set row(recipient) [workflow::role::get_id \
+ -workflow_id $workflow_id \
+ -short_name $row(recipient_role)]
+ }
+ unset row(recipient_role)
+ }
+
+ set update_clauses [list]
+ set insert_names [list]
+ set insert_values [list]
+
+ # Handle columns in the sim_tasks table
+ foreach attr {
+ recipient attachment_num
+ } {
+ if { [info exists row($attr)] } {
+ set varname attr_$attr
+ # Convert the Tcl value to something we can use in the query
+ switch $attr {
+ default {
+ set $varname $row($attr)
+ }
+ }
+ # Add the column to the insert/update statement
+ switch $attr {
+ default {
+ lappend update_clauses "$attr = :$varname"
+ lappend insert_names $attr
+ lappend insert_values :$varname
+ }
+ }
+ unset row($attr)
+ }
+ }
+ }
+ }
+
+ db_transaction {
+ # Base row
+ set action_id [workflow::action::fsm::edit \
+ -internal \
+ -operation $operation \
+ -action_id $action_id \
+ -workflow_id $workflow_id \
+ -array row]
+
+ # sim_tasks row
+ switch $operation {
+ insert {
+ lappend insert_names task_id
+ lappend insert_values :action_id
+
+ db_dml insert_action "
+ insert into sim_tasks
+ ([join $insert_names ", "])
+ values
+ ([join $insert_values ", "])
+ "
+ }
+ update {
+ if { [llength $update_clauses] > 0 } {
+ db_dml update_action "
+ update sim_tasks
+ set [join $update_clauses ", "]
+ where task_id = :action_id
+ "
+ }
+ }
+ delete {
+ # Handled through cascading delete
+ }
+ }
+
+ if { !$internal_p } {
+ workflow::definition_changed_handler -workflow_id $workflow_id
+ }
+ }
+
+ if { !$internal_p } {
+ workflow::flush_cache -workflow_id $workflow_id
+ }
+
+ return $action_id
+}
+
+
+ad_proc -public simulation::action::get {
+ {-local_only:boolean}
+ {-action_id:required}
+ {-array:required}
+} {
+ Get information about a simulation action.
+
+ @param local_only Set this to only get the attributes from the simulation extension table,
+ not the ones derived from workflow::action::fsm.
+} {
+ upvar 1 $array row
+
+ if { !$local_only_p } {
+ workflow::action::fsm::get -action_id $action_id -array row
+ }
+
+ db_1row select_action {
+ select recipient,
+ (select short_name
+ from workflow_roles
+ where role_id = recipient) as recipient_role,
+ attachment_num
+ from sim_tasks
+ where task_id = :action_id
+ } -column_array local_row
+
+ array set row [array get local_row]
+}
+
+
+ad_proc -private simulation::action::generate_spec {
+ {-action_id {}}
+ {-one_id {}}
+} {
+ Generate the spec for an individual simulation task definition.
+
+ @param action_id The id of the action to generate spec for.
+
+ @param one_id Same as action_id, just used for consistency across roles/actions/states.
+
+ @return spec The actions spec
+
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ if { [empty_string_p $action_id] } {
+ if { [empty_string_p $one_id] } {
+ error "You must supply either action_id or one_id"
+ }
+ set action_id $one_id
+ } else {
+ if { ![empty_string_p $one_id] } {
+ error "You can only supply either action_id or one_id"
+ }
+ }
+
+ set spec [workflow::action::fsm::generate_spec -action_id $action_id]
+
+ get -action_id $action_id -array row -local_only
+
+ array unset row recipient
+
+ foreach name [lsort [array names row]] {
+ if { ![empty_string_p $row($name)] } {
+ lappend spec $name $row($name)
+ }
+ }
+
+ return $spec
+}
+
+ad_proc -public simulation::action::get_ids {
+ {-workflow_id:required}
+} {
+ Get the action_id's of all the actions in the workflow.
+
+ @param workflow_id The ID of the workflow
+
+ @return list of action_id's.
+
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ return [workflow::action::fsm::get_ids -workflow_id $workflow_id]
+}
+
+ad_proc -public simulation::action::get_element {
+ {-action_id {}}
+ {-one_id {}}
+ {-element:required}
+} {
+ Return element from information about an action with a given id, including
+ simulation info.
+
+ @param action_id The ID of the action
+
+ @param one_id Same as action_id, just used for consistency across roles/actions/states.
+
+ @param element The element you want
+
+ @return The element you asked for
+
+ @author Peter Marklund
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ if { [empty_string_p $action_id] } {
+ if { [empty_string_p $one_id] } {
+ error "You must supply either action_id or one_id"
+ }
+ set action_id $one_id
+ } else {
+ if { ![empty_string_p $one_id] } {
+ error "You can only supply either action_id or one_id"
+ }
+ }
+ get -action_id $action_id -array row
+ return $row($element)
+}
Index: openacs-4/packages/simulation/tcl/sim-role-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/simulation/tcl/sim-role-procs.tcl,v
diff -u
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/packages/simulation/tcl/sim-role-procs.tcl 17 Dec 2003 14:05:22 -0000 1.1
@@ -0,0 +1,260 @@
+ad_library {
+ API for Simulation roles.
+
+ @author Lars Pind (lars@collaboraid.biz)
+ @creation-date 2003-10-14
+ @cvs-id $Id: sim-role-procs.tcl,v 1.1 2003/12/17 14:05:22 lars Exp $
+}
+
+namespace eval simulation::role {}
+
+ad_proc -public simulation::role::edit {
+ {-operation "update"}
+ {-role_id {}}
+ {-workflow_id {}}
+ {-array {}}
+ {-internal:boolean}
+} {
+ Edit a role.
+
+ @param operation insert, update, delete
+
+ @param role_id For update/delete: The role to update or delete.
+ For insert: Optionally specify a pre-generated role_id for the role.
+
+ @param workflow_id For update/delete: Optionally specify the workflow_id. If not specified, we will execute a query to find it.
+ For insert: The workflow_id of the new role.
+
+ @param array For insert/update: Name of an array in the caller's namespace with attributes to insert/update.
+
+ @param internal Set this flag if you're calling this proc from within the corresponding proc
+ for a particular workflow model. Will cause this proc to not flush the cache
+ or call workflow::definition_changed_handler, which the caller must then do.
+
+ @return role_id
+
+ @see workflow::role::fsm::edit
+} {
+ switch $operation {
+ update - delete {
+ if { [empty_string_p $role_id] } {
+ error "You must specify the role_id of the role to $operation."
+ }
+ }
+ insert {}
+ default {
+ error "Illegal operation '$operation'"
+ }
+ }
+ switch $operation {
+ insert - update {
+ upvar 1 $array org_row
+ if { ![array exists org_row] } {
+ error "Array $array does not exist or is not an array"
+ }
+ array set row [array get org_row]
+ }
+ }
+ switch $operation {
+ insert {
+ if { [empty_string_p $workflow_id] } {
+ error "You must supply workflow_id"
+ }
+ }
+ update {
+ if { [empty_string_p $workflow_id] } {
+ set workflow_id [workflow::role::get_element \
+ -role_id $role_id \
+ -element workflow_id]
+ }
+ }
+ }
+
+ # Parse column values
+ switch $operation {
+ insert - update {
+ set update_clauses [list]
+ set insert_names [list]
+ set insert_values [list]
+
+ # Handle columns in the sim_tasks table
+ foreach attr {
+ character_id
+ } {
+ if { [info exists row($attr)] } {
+ set varname attr_$attr
+ # Convert the Tcl value to something we can use in the query
+ switch $attr {
+ default {
+ set $varname $row($attr)
+ }
+ }
+ # Add the column to the insert/update statement
+ switch $attr {
+ default {
+ lappend update_clauses "$attr = :$varname"
+ lappend insert_names $attr
+ lappend insert_values :$varname
+ }
+ }
+ unset row($attr)
+ }
+ }
+ }
+ }
+
+ db_transaction {
+ # Base row
+ set role_id [workflow::role::edit \
+ -internal \
+ -operation $operation \
+ -role_id $role_id \
+ -workflow_id $workflow_id \
+ -array row]
+
+ # sim_roles row
+ switch $operation {
+ insert {
+ lappend insert_names role_id
+ lappend insert_values :role_id
+
+ db_dml insert_role "
+ insert into sim_roles
+ ([join $insert_names ", "])
+ values
+ ([join $insert_values ", "])
+ "
+ }
+ update {
+ if { [llength $update_clauses] > 0 } {
+ db_dml update_role "
+ update sim_roles
+ set [join $update_clauses ", "]
+ where role_id = :role_id
+ "
+ }
+ }
+ delete {
+ # Handled through cascading delete
+ }
+ }
+
+ if { !$internal_p } {
+ workflow::definition_changed_handler -workflow_id $workflow_id
+ }
+ }
+
+ if { !$internal_p } {
+ workflow::flush_cache -workflow_id $workflow_id
+ }
+
+ return $role_id
+}
+
+ad_proc -public simulation::role::get {
+ {-local_only:boolean}
+ {-role_id:required}
+ {-array:required}
+} {
+ Get information about a simulation role
+
+ @param local_only Set this to only get the attributes from the simulation extension table,
+ not the ones derived from workflow::role
+} {
+ upvar 1 $array row
+
+ if { !$local_only_p } {
+ workflow::role::get -role_id $role_id -array row
+ }
+
+ db_1row select_sim_role {
+ select role_id,
+ character_id
+ from sim_roles
+ where role_id = :role_id
+ } -column_array local_row
+
+ array set row [array get local_row]
+}
+
+ad_proc -public simulation::role::get_element {
+ {-role_id {}}
+ {-one_id {}}
+ {-element:required}
+} {
+ Return a single element from the information about a role.
+
+ @param role_id The id of the role to get an element for.
+
+ @param one_id Same as role_id, just used for consistency across roles/actions/states.
+
+ @return element The element you asked for
+
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ if { [empty_string_p $role_id] } {
+ if { [empty_string_p $one_id] } {
+ error "You must supply either role_id or one_id"
+ }
+ set role_id $one_id
+ } else {
+ if { ![empty_string_p $one_id] } {
+ error "You can only supply either role_id or one_id"
+ }
+ }
+
+ get -role_id $role_id -array row
+ return $row($element)
+}
+
+ad_proc -private simulation::role::get_ids {
+ {-workflow_id:required}
+} {
+ Get the IDs of all the roles in the right order.
+
+ @param workflow_id The id of the workflow to delete.
+
+ @return A list of role IDs.
+
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ return [workflow::role::get_ids -workflow_id $workflow_id]
+}
+
+ad_proc -private simulation::role::generate_spec {
+ {-role_id {}}
+ {-one_id {}}
+} {
+ Generate the spec for an individual simulation task definition.
+
+ @param role_id The id of the role to generate spec for.
+
+ @param one_id Same as role_id, just used for consistency across roles/roles/states.
+
+ @return spec The roles spec
+
+ @author Lars Pind (lars@collaboraid.biz)
+} {
+ if { [empty_string_p $role_id] } {
+ if { [empty_string_p $one_id] } {
+ error "You must supply either role_id or one_id"
+ }
+ set role_id $one_id
+ } else {
+ if { ![empty_string_p $one_id] } {
+ error "You can only supply either role_id or one_id"
+ }
+ }
+
+ set spec [workflow::role::generate_spec -role_id $role_id]
+
+ get -role_id $role_id -array row -local_only
+
+ foreach name [lsort [array names row]] {
+ if { ![empty_string_p $row($name)] } {
+ lappend spec $name $row($name)
+ }
+ }
+
+ return $spec
+}