Create a logger project.
- I've tried to design this proc so that it can be used also - if there is no HTTP (ad_conn) connection, for example during a data import. + This proc requires the ad_conn proc to be initialized (uses user_id, peeraddr, and package_id). + The ad_conn proc is initialized + by the request processor during an HTTP request to an OpenACS server.
@param name The name of the project. - @param project_id Any pre-generated id of the new package. Optional. - @param package_id The id of the Logger package in which the project is created. Defaults - to ad_conn package_id. Also used as context_id. @param description The description for the proct. Optional. @param project_lead The user id of the project leader of the project. Defaults to the currently logged in user. - @param creation_user The user creating the project. Defaults to ad_conn user_id. - @param creation_ip The ip of the user creating the project. Defaults to ad_conn peeraddr - + @param project_id Any pre-generated id of the new package. Optional. + @return The project_id of the created project. @author Peter Marklund } { - # Use ad_conn to setup default values and check that required values are provided - # if there is no ad_conn - # The lists are on the array format + # Use ad_conn to initialize variables + # The lists are on the following array format # var_name1 ad_conn_arg_name1 var_name2 ad_conn_arg_name2 ... - set required_ad_conn_vars [list package_id package_id creation_user user_id] - set optional_ad_conn_vars [list creation_ip peeraddr] + set ad_conn_vars [list package_id package_id creation_user user_id creation_ip peeraddr] if { [ad_conn isconnected] } { - # HTTP connection available - - # ad_conn provides default values for us - foreach {var_name ad_conn_name} [concat $required_ad_conn_vars $optional_ad_conn_vars] { - if { [empty_string_p [set $var_name]] } { + foreach {var_name ad_conn_name} $ad_conn_vars { set $var_name [ad_conn $ad_conn_name] - - # If we are using ad_conn package_id - # we might as well use ad_conn to check that its a logger package - if { [string equal $var_name package_id] } { - if { ![string equal [ad_conn package_key] logger] } { - error "logger::project::new Defaulting package_id to the current package with key [ad_conn package_key] but package must be a logger package" - } - } - } } - - } else { - # No HTTP connection - - # Default optional ad_conn vars to the empty string - foreach {var_name ad_conn_name} $optional_ad_conn_vars { - set $var_name "" - } - - # Assert that required ad_conn variables are provided - foreach var_name $required_ad_conn_vars { - if { [empty_string_p [set $var_name]] } { - error "logger::project::new - the $var_name argument was not provided and there is no ad_conn (HTTP) connection so a default value cannot be set" - } - } + error "logger::project::new - this proc requires an ad_conn connection" } # Project lead defaults to creation user if { [empty_string_p $project_lead] } { set project_lead $creation_user } + # Insert the project set project_id [db_exec_plsql insert_project {}] return $project_id } +ad_proc -public logger::project::edit { + {-project_id:required} + {-name:required} + {-description:required} + {-project_lead:required} + {-active_p:required} +} { + Edit a Logger project. + + @param project_id The id of the project to edit + @param name The new name + @param description The new description + @param project_lead The new id of the project lead + @param active_p The new value for active_p, must be t (true) or f (false) + + @return The return value from db_dml + + @author Peter Marklund +} { + ad_assert_arg_value_in_list active_p {t f} + + db_dml update_project {} +} + ad_proc -public logger::project::delete { {-project_id:required} } { @@ -190,3 +180,18 @@ } { return [db_list select_variables {}] } + +ad_proc -public logger::project::get_primary_variable { + {-project_id:required} +} { + Return the id of the variable primarily logged in for a certain project. + + @param project_id The id of the project to return the primary variable for. + + @return The id of the primary variable. Returns the empty string if the + project has no primary variable. + + @author Peter Marklund +} { + return [db_string select_primary_variable {} -default ""] +} \ No newline at end of file Index: openacs-4/packages/logger/tcl/project-procs.xql =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/logger/tcl/project-procs.xql,v diff -u -N -r1.3 -r1.4 --- openacs-4/packages/logger/tcl/project-procs.xql 6 Apr 2003 09:26:47 -0000 1.3 +++ openacs-4/packages/logger/tcl/project-procs.xql 22 Apr 2003 09:25:40 -0000 1.4 @@ -30,6 +30,15 @@ ++ Return 1 if the navbar link with given URL (relative server URL) should be marked + selected in the UI for the current request and 0 otherwise. +
+ ++ A link is considered selected if the current page url starts with the url of the link + followed by the optional slash, question mark and query string +
+ + @author Peter Marklund +} { + # Let's remove any trailing slash and make it optional in our pattern + regsub {(.*)/$} $navbar_url {\1} url_no_slash + + # For readability I define the pattern in curly braces which avoids a lot of backslashes + set selected_pattern {^
+
+
+
+
|
+
+
+
+
+
|
+ |||||||||||||
+ Before anyone can start working with the Logger application an administrator needs to setup a project. +
++ Since you are an administrator you may visit the admin pages to do so now. +
++ Please contact an administrator about this. Thank you. +
++Index: openacs-4/packages/logger/www/log.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/logger/www/log.tcl,v diff -u -N --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/logger/www/log.tcl 22 Apr 2003 09:26:17 -0000 1.1 @@ -0,0 +1,137 @@ +ad_page_contract { + Add/edit/display a log entry. + + @author Peter marklund (peter@collaboraid.biz) + @creation-date 2003-04-16 + @cvs-id $Id: log.tcl,v 1.1 2003/04/22 09:26:17 peterm Exp $ +} { + measurement_id:integer,optional + project_id:integer,optional + variable_id:integer,optional +} -validate { + project_id_required_in_add_mode { + # For the sake of simplicity of the form + # we are requiring a project_id to be provided in add mode + if { ![exists_and_not_null measurement_id] && ![exists_and_not_null project_id] } { + ad_complain "When adding a log entry a project_id must be provided (either measurement_id or project_id must be present)." + } + } +} + +set package_id [ad_conn package_id] + +if { ![empty_string_p [ns_set iget [rp_getform] formbutton:done_button]] } { + # User is done editing - redirect back to index page + ad_returnredirect index + ad_script_abort +} + +# Different page title and form mode when adding a log entry +# versus displaying/editing one +if { [exists_and_not_null measurement_id] } { + # Initial request in display or edit mode or a submit of the form + set page_title "One Log Entry" + set ad_form_mode display +} else { + # Initial request in add mode + set page_title "Add a Log Entry" + set ad_form_mode edit +} + +set context [list $page_title] + +# Build the log entry form elements +ad_form -name log_entry_form -cancel_url index -mode $ad_form_mode -actions [list [list Edit "formbuilder::edit"] [list Done done_button]] -form { + measurement_id:key(acs_object_id_seq) +} + +# On various occasions we need to know if we are dealing with a submit with the +# form or an initial request (could also be with error message after unaccepted submit) +set submit_p [form is_valid log_entry_form] + +# Initial request of form or input error +if { ! $submit_p } { + + # Add project and variable elements to the form + # Get project_id if it's not provided + if { ![exists_and_not_null project_id] } { + logger::measurement::get -measurement_id $measurement_id -array measurement + set project_id $measurement(project_id) + } + # For simplicity - use the primary variable of the + # project + set variable_id [logger::project::get_primary_variable -project_id $project_id] + # We need project and variable names + logger::project::get -project_id $project_id -array project + logger::variable::get -variable_id $variable_id -array variable + ad_form -extend -name log_entry_form -form { + {project:text(inform) + {label Project} + {value $project(name)} + } + + {variable:text(inform) + {label Variable} + {value "$variable(name) ($variable(unit))"} + } + + {project_id:integer(hidden) + {value $project_id} + } + + {variable_id:integer(hidden) + {value $variable_id} + } + } +} + +# Add form elements common to all modes +# The form builder date datatype doesn't understand standard ANSI format date strings +regsub -all -- {-} [dt_systime] { } default_date +ad_form -extend -name log_entry_form -form { + {value:integer + {label Value} + } + + {time_stamp:date + {label Date} + {value $default_date} + } + + description:text,optional +} + +# Execute the form +ad_form -extend -name log_entry_form -select_query { + select project_id, + variable_id, + value, + to_char(time_stamp, 'YYYY MM DD') as time_stamp, + description + from logger_measurements + where measurement_id = :measurement_id +} -new_data { + set time_stamp_ansi "[lindex $time_stamp 0]-[lindex $time_stamp 1]-[lindex $time_stamp 2]" + logger::measurement::new -measurement_id $measurement_id \ + -project_id $project_id \ + -variable_id $variable_id \ + -value $value \ + -time_stamp $time_stamp_ansi \ + -description $description +} -edit_data { + set time_stamp_ansi "[lindex $time_stamp 0]-[lindex $time_stamp 1]-[lindex $time_stamp 2]" + logger::measurement::edit -measurement_id $measurement_id \ + -value $value \ + -time_stamp $time_stamp_ansi \ + -description $description +} -on_submit { + + ns_log Notice "pm debug on_submit" + +} -after_submit { + + ns_log Notice "pm debug after_submit" + + ad_returnredirect "[ad_conn url]?measurement_id=$measurement_id" + ad_script_abort +} Index: openacs-4/packages/logger/www/master.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/logger/www/Attic/master.adp,v diff -u -N --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/logger/www/master.adp 22 Apr 2003 09:26:17 -0000 1.1 @@ -0,0 +1,2 @@ ++
+
+ <% # Project table header %>
+
+
+
+
+
+
+ There are no projects
+
+
+
+
+
+
+
+
+ There are no variables
+
+
+
\ No newline at end of file
Index: openacs-4/packages/logger/www/admin/index.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/logger/www/admin/index.tcl,v
diff -u -N
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/packages/logger/www/admin/index.tcl 22 Apr 2003 09:27:03 -0000 1.1
@@ -0,0 +1,19 @@
+ad_page_contract {
+ Administration index page for the Logger application.
+
+ @author Peter marklund (peter@collaboraid.biz)
+ @creation-date 2003-04-08
+ @cvs-id $Id: index.tcl,v 1.1 2003/04/22 09:27:03 peterm Exp $
+}
+
+set package_id [ad_conn package_id]
+set user_id [ad_conn user_id]
+set page_title "Logger Administration"
+
+set home_url [ad_parameter -package_id [ad_acs_kernel_id] HomeURL]
+
+db_multirow projects select_projects {}
+
+logger::package::variables_multirow
+
+ad_return_template
Index: openacs-4/packages/logger/www/admin/map-variable-to-project-2.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/logger/www/admin/map-variable-to-project-2.tcl,v
diff -u -N
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/packages/logger/www/admin/map-variable-to-project-2.tcl 22 Apr 2003 09:27:03 -0000 1.1
@@ -0,0 +1,14 @@
+ad_page_contract {
+ Add a variable to a logger project.
+
+ @author Peter marklund (peter@collaboraid.biz)
+ @creation-date 2003-04-16
+ @cvs-id $Id: map-variable-to-project-2.tcl,v 1.1 2003/04/22 09:27:03 peterm Exp $
+} {
+ project_id:integer
+ variable_id:integer
+}
+
+logger::project::add_variable -project_id $project_id -variable_id $variable_id
+
+ad_returnredirect "project?project_id=$project_id"
Index: openacs-4/packages/logger/www/admin/map-variable-to-project.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/logger/www/admin/map-variable-to-project.adp,v
diff -u -N
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/packages/logger/www/admin/map-variable-to-project.adp 22 Apr 2003 09:27:03 -0000 1.1
@@ -0,0 +1,15 @@
+Projects
+ +| Project Name | +Project Description | +Active | +Project Lead | +
|---|---|---|---|
| @projects.name@
+ |
+ @projects.description@ | +@projects.project_lead_name@ | +
+ Add new project +
+ +Variables
+ +| Name | +Unit | +Additive | +
|---|---|---|
| @variables.name@ | +@variables.unit@ | +
+ Add new variable +
+-
+
- @variables.name@ + (@variables.unit@, @variables.type@) +
+Index: openacs-4/packages/logger/www/admin/project.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/logger/www/admin/project.tcl,v diff -u -N --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/logger/www/admin/project.tcl 22 Apr 2003 09:27:03 -0000 1.1 @@ -0,0 +1,101 @@ +ad_page_contract { + Add/edit/display a project for this Logger application instance. + + @author Peter marklund (peter@collaboraid.biz) + @creation-date 2003-04-08 + @cvs-id $Id: project.tcl,v 1.1 2003/04/22 09:27:03 peterm Exp $ +} { + project_id:integer,optional +} + +set package_id [ad_conn package_id] + +if { [exists_and_not_null project_id] } { + # Initial request in display or edit mode or a submit of the form + set page_title "One Project" + set ad_form_mode display +} else { + # Initial request in add mode + set page_title "Add a Project" + set ad_form_mode edit +} + +set context [list $page_title] + +ad_form -name project_form -cancel_url index -mode $ad_form_mode -form { + project_id:key(acs_object_id_seq) + + name:text + + description:text(textarea),optional +} + +if { [exists_and_not_null project_id] } { + # We are in edit or display mode + # Display the variables linked to this project + set variables_list [list] + set variables_text "" + db_foreach variables_in_project { + select lv.variable_id, + lv.name + from logger_project_var_map lpvm, + logger_variables lv + where lpvm.variable_id = lv.variable_id + and lpvm.project_id = :project_id + } { + lappend variables_list "$name" + } + + if { [llength $variables_list] != 0 } { + set variables_text [join $variables_list ", "] + } else { + set variables_text "no variables" + } + append variables_text " \[add variable\]" + + + ad_form -extend -name project_form -form { + {variables:text(inform) + {label Variables} + {value $variables_text} + } + } + +} else { + # We are in add mode +} + +# Finalize the form with the execution blocks +ad_form -extend -name project_form -select_query { + select name, + description + from logger_projects + where project_id = :project_id +} -validate { + { + name + { ![empty_string_p [string trim $name]] } + { A name with only spaces is not allowed } + } + +} -new_data { + + logger::project::new -project_id $project_id \ + -name $name \ + -description $description \ +} -edit_data { + + # The edit proc requires all attributes to be provided + # so use the old values for project_lead and active_p + logger::project::get -project_id $project_id -array old_project + logger::project::edit -project_id $project_id \ + -name $name \ + -description $description \ + -project_lead $old_project(project_lead) \ + -active_p $old_project(active_p) +} -after_submit { + + ad_returnredirect "[ad_conn url]?project_id=$project_id" + + ad_script_abort +} Index: openacs-4/packages/logger/www/admin/variable.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/logger/www/admin/variable.adp,v diff -u -N --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/logger/www/admin/variable.adp 22 Apr 2003 09:27:03 -0000 1.1 @@ -0,0 +1,7 @@ ++
+Index: openacs-4/packages/logger/www/admin/variable.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/logger/www/admin/variable.tcl,v diff -u -N --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/logger/www/admin/variable.tcl 22 Apr 2003 09:27:03 -0000 1.1 @@ -0,0 +1,64 @@ +ad_page_contract { + Add/edit/display a variable for this Logger application instance. + + @author Peter marklund (peter@collaboraid.biz) + @creation-date 2003-04-15 + @cvs-id $Id: variable.tcl,v 1.1 2003/04/22 09:27:03 peterm Exp $ +} { + variable_id:optional +} + +set package_id [ad_conn package_id] + +if { [exists_and_not_null variable_id] } { + # Initial request in display or edit mode or a submit of the form + set page_title "One variable" + set ad_form_mode display +} else { + # Initial request in add mode + set page_title "Add a variable" + set ad_form_mode edit +} + +set context [list $page_title] + +ad_form -name variable_form -cancel_url index -mode $ad_form_mode -form { + variable_id:key(logger_variables_seq) + + name:text + + unit:text + + {type:text(radio) + {options {{Additive additive} {Non-Additive non-additive}}} + } + +} -select_query { + select name, + unit, + type + from logger_variables + where variable_id = :variable_id + +} -validate { + { + name + { ![empty_string_p [string trim $name]] } + { A name with only spaces is not allowed } + } + +} -new_data { + logger::variable::new -variable_id $variable_id \ + -name $name \ + -unit $unit \ + -type $type +} -edit_data { + logger::variable::edit -variable_id $variable_id \ + -name $name \ + -unit $unit \ + -type $type +} -after_submit { + + ad_returnredirect "[ad_conn url]?variable_id=$variable_id" + ad_script_abort +} Index: openacs-4/packages/logger/www/lib/master.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/logger/www/lib/Attic/master.adp,v diff -u -N --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/logger/www/lib/master.adp 22 Apr 2003 09:28:13 -0000 1.1 @@ -0,0 +1,29 @@ ++
|
+ |
+
+
|
+