From 1f076c151bf0da28b041745dc6035c525a7c268e Mon Sep 17 00:00:00 2001 From: Vamsi Krishna Davuluri Date: Sun, 16 Aug 2009 15:55:51 +0000 Subject: Add footer to Moodle Print \ more sensible interface messages --- diff --git a/Moodle/mod/print/README.txt b/Moodle/mod/print/README.txt deleted file mode 100755 index c9d7bf1..0000000 --- a/Moodle/mod/print/README.txt +++ /dev/null @@ -1,75 +0,0 @@ -$Id: README.txt,v 1.2.2.2 2009/03/18 14:49:20 mudrd8mz Exp $ - -HOW TO STARTUP WITH A NEW ACTIVITY MODULE -========================================= - -The following steps should get you up and running with -this module template code. - -As you are able to read this file, you have probably managed to get this -source code from either the CVS repository or from the zip archive. Well done! - -Read this README file. - -Make sure you have read this file :-) - -Rename the NEWMODULE folder into a lower case name of your module. Make sure -your name is not used by any standard or contributed modules (see -http://cvs.moodle.org/contrib/plugins/mod/ for the list of currently -contributed modules). - -Edit all the files in this directory and its subdirectories and change all the -instances of string "print" to your new module name (eg "widget"). - -Rename the file lang/en_utf8/print.php to widget.php or whatever your -module name is. - -Place the widget folder into the /mod folder of your development moodle -directory. - -Go to http://localhost/your/moodle/admin/xmldb/ directory. Try to not to visit -the main admin page (Notifications) so the module is not installed yet. If it -gets installed accidentaly, uninstall it from the database via Manage -activities admin page. You will probably uninstall and reinstall the module -quite often during the early stages of the development. - -In XMLDB editor, add all tables, fields and statements needed to implement the -module features. See http://docs.moodle.org/en/Development:Using_XMLDB for -more information. Do not forget to use the [Save] link at the XMLDB main page -so the changes are written into install.xml file. If the link is not active, -the web server process (eg. apache user) does not have permission to write -into mod/widget/db/install.xml file - -Visit the admin Notifications page (admin/index.php). The module tables should -get installed. - -You can go to Modules > Activities in the Site Administration block. You -should find that this print has been added to the list of recognized -modules. - -You may now proceed to run your own code in an attempt to develop for moodle. -Good luck with that. For help with developing code for moodle, visit the -"Activity modules" developers forum in the online course called "Using Moodle" -at http://moodle.org. - - -What to do next ---------------- - -Go through the lib.php, index.php and view.php files. - -You will probably want to add some capabilities regarding your module. Look at -db/access.php. Note that you have to increase the version number defined in -version.php to let Moodle update the capabilities information. - -If you do any change to the database structure (adding a field, changing the -field definition etc.) use XMLDB editor again. Use the PHP code generated by -XMLDB and push it into db/upgrade.php. Save the change into install.xml (for -fresh installations), increase the version number and go to admin/index.php -again. During upgrade, Moodle calls a function in db/upgrade.php to perform -the DB changes. - -Credits for work on this NEWMODULE template -------------------------------------------- -Martin Dougiamas for the original work -Chris B Stones (http://www.welcometochrisworld.com) for revision of the code diff --git a/Moodle/mod/print/compat/array_key_exists.php b/Moodle/mod/print/compat/array_key_exists.php new file mode 100644 index 0000000..4a93ce4 --- /dev/null +++ b/Moodle/mod/print/compat/array_key_exists.php @@ -0,0 +1,55 @@ + | +// +----------------------------------------------------------------------+ +// +// $Id: array_key_exists.php 2 2009-03-16 20:22:51Z ggiunta $ + + +/** + * Replace array_key_exists() + * + * @category PHP + * @package PHP_Compat + * @link http://php.net/function.array_key_exists + * @author Aidan Lister + * @version $Revision: 1.1 $ + * @since PHP 4.1.0 + * @require PHP 4.0.0 (user_error) + */ +if (!function_exists('array_key_exists')) { + function array_key_exists($key, $search) + { + if (!is_scalar($key)) { + user_error('array_key_exists() The first argument should be either a string or an integer', + E_USER_WARNING); + return false; + } + + if (is_object($search)) { + $search = get_object_vars($search); + } + + if (!is_array($search)) { + user_error('array_key_exists() The second argument should be either an array or an object', + E_USER_WARNING); + return false; + } + + return in_array($key, array_keys($search)); + } +} + +?> \ No newline at end of file diff --git a/Moodle/mod/print/compat/is_a.php b/Moodle/mod/print/compat/is_a.php new file mode 100644 index 0000000..2c5c129 --- /dev/null +++ b/Moodle/mod/print/compat/is_a.php @@ -0,0 +1,47 @@ + | +// +----------------------------------------------------------------------+ +// +// $Id: is_a.php 2 2009-03-16 20:22:51Z ggiunta $ + + +/** + * Replace function is_a() + * + * @category PHP + * @package PHP_Compat + * @link http://php.net/function.is_a + * @author Aidan Lister + * @version $Revision: 1.2 $ + * @since PHP 4.2.0 + * @require PHP 4.0.0 (user_error) (is_subclass_of) + */ +if (!function_exists('is_a')) { + function is_a($object, $class) + { + if (!is_object($object)) { + return false; + } + + if (get_class($object) == strtolower($class)) { + return true; + } else { + return is_subclass_of($object, $class); + } + } +} + +?> \ No newline at end of file diff --git a/Moodle/mod/print/compat/is_callable.php b/Moodle/mod/print/compat/is_callable.php new file mode 100644 index 0000000..419697a --- /dev/null +++ b/Moodle/mod/print/compat/is_callable.php @@ -0,0 +1,53 @@ + + * @version $Id: is_callable.php 2 2009-03-16 20:22:51Z ggiunta $ + * @since PHP 4.0.6 + * @require PHP 4.0.0 (true, false, etc...) + * @todo add the 3rd parameter syntax... + */ +if (!function_exists('is_callable')) { + function is_callable($var, $syntax_only=false) + { + if ($syntax_only) + { + /* from The Manual: + * If the syntax_only argument is TRUE the function only verifies + * that var might be a function or method. It will only reject simple + * variables that are not strings, or an array that does not have a + * valid structure to be used as a callback. The valid ones are + * supposed to have only 2 entries, the first of which is an object + * or a string, and the second a string + */ + return (is_string($var) || (is_array($var) && count($var) == 2 && is_string(end($var)) && (is_string(reset($var)) || is_object(reset($var))))); + } + else + { + if (is_string($var)) + { + return function_exists($var); + } + else if (is_array($var) && count($var) == 2 && is_string($method = end($var))) + { + $obj = reset($var); + if (is_string($obj)) + { + $methods = get_class_methods($obj); + return (bool)(is_array($methods) && in_array(strtolower($method), $methods)); + } + else if (is_object($obj)) + { + return method_exists($obj, $method); + } + } + return false; + } + } +} + +?> \ No newline at end of file diff --git a/Moodle/mod/print/compat/is_scalar.php b/Moodle/mod/print/compat/is_scalar.php new file mode 100644 index 0000000..dd87730 --- /dev/null +++ b/Moodle/mod/print/compat/is_scalar.php @@ -0,0 +1,38 @@ + \ No newline at end of file diff --git a/Moodle/mod/print/compat/var_export.php b/Moodle/mod/print/compat/var_export.php new file mode 100644 index 0000000..7273a1e --- /dev/null +++ b/Moodle/mod/print/compat/var_export.php @@ -0,0 +1,105 @@ + | +// +----------------------------------------------------------------------+ +// +// $Id: var_export.php 2 2009-03-16 20:22:51Z ggiunta $ + + +/** + * Replace var_export() + * + * @category PHP + * @package PHP_Compat + * @link http://php.net/function.var_export + * @author Aidan Lister + * @version $Revision: 1.2 $ + * @since PHP 4.2.0 + * @require PHP 4.0.0 (user_error) + */ +if (!function_exists('var_export')) { + function var_export($array, $return = false, $lvl=0) + { + // Common output variables + $indent = ' '; + $doublearrow = ' => '; + $lineend = ",\n"; + $stringdelim = '\''; + + // Check the export isn't a simple string / int + if (is_string($array)) { + $out = $stringdelim . str_replace('\'', '\\\'', str_replace('\\', '\\\\', $array)) . $stringdelim; + } elseif (is_int($array) || is_float($array)) { + $out = (string)$array; + } elseif (is_bool($array)) { + $out = $array ? 'true' : 'false'; + } elseif (is_null($array)) { + $out = 'NULL'; + } elseif (is_resource($array)) { + $out = 'resource'; + } else { + // Begin the array export + // Start the string + $out = "array (\n"; + + // Loop through each value in array + foreach ($array as $key => $value) { + // If the key is a string, delimit it + if (is_string($key)) { + $key = str_replace('\'', '\\\'', str_replace('\\', '\\\\', $key)); + $key = $stringdelim . $key . $stringdelim; + } + + $val = var_export($value, true, $lvl+1); + // Delimit value + /*if (is_array($value)) { + // We have an array, so do some recursion + // Do some basic recursion while increasing the indent + $recur_array = explode($newline, var_export($value, true)); + $temp_array = array(); + foreach ($recur_array as $recur_line) { + $temp_array[] = $indent . $recur_line; + } + $recur_array = implode($newline, $temp_array); + $value = $newline . $recur_array; + } elseif (is_null($value)) { + $value = 'NULL'; + } else { + $value = str_replace($find, $replace, $value); + $value = $stringdelim . $value . $stringdelim; + }*/ + + // Piece together the line + for ($i = 0; $i < $lvl; $i++) + $out .= $indent; + $out .= $key . $doublearrow . $val . $lineend; + } + + // End our string + for ($i = 0; $i < $lvl; $i++) + $out .= $indent; + $out .= ")"; + } + + // Decide method of output + if ($return === true) { + return $out; + } else { + echo $out; + return; + } + } +} +?> \ No newline at end of file diff --git a/Moodle/mod/print/compat/version_compare.php b/Moodle/mod/print/compat/version_compare.php new file mode 100644 index 0000000..a1211ea --- /dev/null +++ b/Moodle/mod/print/compat/version_compare.php @@ -0,0 +1,179 @@ + | +// | Aidan Lister | +// +----------------------------------------------------------------------+ +// +// $Id: version_compare.php 2 2009-03-16 20:22:51Z ggiunta $ + + +/** + * Replace version_compare() + * + * @category PHP + * @package PHP_Compat + * @link http://php.net/function.version_compare + * @author Philippe Jausions + * @author Aidan Lister + * @version $Revision: 1.1 $ + * @since PHP 4.1.0 + * @require PHP 4.0.0 (user_error) + */ +if (!function_exists('version_compare')) { + function version_compare($version1, $version2, $operator = '<') + { + // Check input + if (!is_scalar($version1)) { + user_error('version_compare() expects parameter 1 to be string, ' . + gettype($version1) . ' given', E_USER_WARNING); + return; + } + + if (!is_scalar($version2)) { + user_error('version_compare() expects parameter 2 to be string, ' . + gettype($version2) . ' given', E_USER_WARNING); + return; + } + + if (!is_scalar($operator)) { + user_error('version_compare() expects parameter 3 to be string, ' . + gettype($operator) . ' given', E_USER_WARNING); + return; + } + + // Standardise versions + $v1 = explode('.', + str_replace('..', '.', + preg_replace('/([^0-9\.]+)/', '.$1.', + str_replace(array('-', '_', '+'), '.', + trim($version1))))); + + $v2 = explode('.', + str_replace('..', '.', + preg_replace('/([^0-9\.]+)/', '.$1.', + str_replace(array('-', '_', '+'), '.', + trim($version2))))); + + // Replace empty entries at the start of the array + while (empty($v1[0]) && array_shift($v1)) {} + while (empty($v2[0]) && array_shift($v2)) {} + + // Release state order + // '#' stands for any number + $versions = array( + 'dev' => 0, + 'alpha' => 1, + 'a' => 1, + 'beta' => 2, + 'b' => 2, + 'RC' => 3, + '#' => 4, + 'p' => 5, + 'pl' => 5); + + // Loop through each segment in the version string + $compare = 0; + for ($i = 0, $x = min(count($v1), count($v2)); $i < $x; $i++) { + if ($v1[$i] == $v2[$i]) { + continue; + } + $i1 = $v1[$i]; + $i2 = $v2[$i]; + if (is_numeric($i1) && is_numeric($i2)) { + $compare = ($i1 < $i2) ? -1 : 1; + break; + } + // We use the position of '#' in the versions list + // for numbers... (so take care of # in original string) + if ($i1 == '#') { + $i1 = ''; + } elseif (is_numeric($i1)) { + $i1 = '#'; + } + if ($i2 == '#') { + $i2 = ''; + } elseif (is_numeric($i2)) { + $i2 = '#'; + } + if (isset($versions[$i1]) && isset($versions[$i2])) { + $compare = ($versions[$i1] < $versions[$i2]) ? -1 : 1; + } elseif (isset($versions[$i1])) { + $compare = 1; + } elseif (isset($versions[$i2])) { + $compare = -1; + } else { + $compare = 0; + } + + break; + } + + // If previous loop didn't find anything, compare the "extra" segments + if ($compare == 0) { + if (count($v2) > count($v1)) { + if (isset($versions[$v2[$i]])) { + $compare = ($versions[$v2[$i]] < 4) ? 1 : -1; + } else { + $compare = -1; + } + } elseif (count($v2) < count($v1)) { + if (isset($versions[$v1[$i]])) { + $compare = ($versions[$v1[$i]] < 4) ? -1 : 1; + } else { + $compare = 1; + } + } + } + + // Compare the versions + if (func_num_args() > 2) { + switch ($operator) { + case '>': + case 'gt': + return (bool) ($compare > 0); + break; + case '>=': + case 'ge': + return (bool) ($compare >= 0); + break; + case '<=': + case 'le': + return (bool) ($compare <= 0); + break; + case '==': + case '=': + case 'eq': + return (bool) ($compare == 0); + break; + case '<>': + case '!=': + case 'ne': + return (bool) ($compare != 0); + break; + case '': + case '<': + case 'lt': + return (bool) ($compare < 0); + break; + default: + return; + } + } + + return $compare; + } +} + +?> \ No newline at end of file diff --git a/Moodle/mod/print/lang/en_utf8/newmodule.php b/Moodle/mod/print/lang/en_utf8/newmodule.php deleted file mode 100755 index 13026b3..0000000 --- a/Moodle/mod/print/lang/en_utf8/newmodule.php +++ /dev/null @@ -1,12 +0,0 @@ - diff --git a/Moodle/mod/print/lang/en_utf8/print.php b/Moodle/mod/print/lang/en_utf8/print.php new file mode 100755 index 0000000..c12d6a8 --- /dev/null +++ b/Moodle/mod/print/lang/en_utf8/print.php @@ -0,0 +1,12 @@ + diff --git a/Moodle/mod/print/lib.php b/Moodle/mod/print/lib.php index 6bcc38c..fbc5229 100755 --- a/Moodle/mod/print/lib.php +++ b/Moodle/mod/print/lib.php @@ -66,9 +66,9 @@ class print_base { } #$this->submissions = $this->check_database("print_submissions"); - $this->printconfig->cmidnumber = $this->cm->id; // compatibility with modedit assignment obj - $this->printconfig->courseid = $this->course->id; // compatibility with modedit assignment obj - $this->printconfig->maxbytes = 2097152; + $this->printconfig->id = $this->cm->id; // compatibility with modedit assignment obj + $this->printconfig->course = $this->course->id; // compatibility with modedit assignment obj + } function check_database($table) { global $CFG,$USER; @@ -83,45 +83,36 @@ function check_database($table) { function view1() { global $USER; + + require_capability('mod/print:view', $this->context); - require_capability('mod/print:view', $this->context); - - add_to_log($this->course->id, 'print', 'view', "view.php?id={$this->cm->id}", $this->printconfig->id, $this->cm->id); - - $this->view_header(); + add_to_log($this->course->id, 'print', 'view', "view.php?id={$this->cm->id}", $this->printconfig->id, $this->cm->id); + $this->view_header(); - if (has_capability('mod/print:submit', $this->context)) { - - if ($this->submissions = get_records_sql($this->check_database("print_submissions"))) { - - - } else { - $substring = "No Submissions yet"; - print_simple_box(get_string('nofilesyet', 'assignment'), 'center'); - } - + + if (has_capability('mod/print:submit', $this->context)) { - $filecount = $this->count_user_files($USER->id); - $submission = $this->get_submissions1($USER->id); + $filecount = $this->count_user_files($USER->id); + $submission = $this->get_submissions1($USER->id); - # $this->view_feedback(); - print_heading(get_string('submissiondraft', 'assignment'), '', 3); + print_heading(get_string('submissiondraft', 'assignment'), '', 3); - if ($filecount and $submission) { - print_simple_box($this->print_user_files($USER->id, true), 'center'); - } else { - print_simple_box(get_string('nofilesyet', 'assignment'), 'center'); - } + if ($filecount and $submission) { + print_simple_box($this->print_user_files($USER->id, true), 'center'); + } else { + print_simple_box(get_string('nofilesyet', 'assignment'), 'center'); + } - $this->view_upload_form(); - + $this->view_upload_form(); + print_footer($this->course); - } - } + } +} + function view_header($subpage='') { global $CFG; @@ -410,15 +401,11 @@ function view1() { $auser->status = 1; } - $buttontext = ($auser->status == 1) ? $strupdate : $strgrade; + $text = ($auser->status == 1) ? 'Assignment Ready' : 'No Print Submissions'; ///No more buttons, we use popups ;-). - $popup_url = '/mod/print/submissions.php?id='.$this->cm->id - . '&userid='.$auser->id.'&mode=single'.'&offset='.$offset++; - $button = link_to_popup_window ($popup_url, 'grade'.$auser->id, $buttontext, 600, 780, - $buttontext, 'none', true, 'button'.$auser->id); - - $status = '
'.$button.'
'; + $text; + $status = '
'.$text.'
'; $url = $this->print_user_files($auser->id,true,true); $submissions = '
'.$url.'
'; @@ -477,7 +464,7 @@ function view1() { echo ''; echo ''; ///End of mini form -# print_footer($this->course); + print_footer($this->course); } @@ -672,9 +659,9 @@ function view1() { notify(get_string('deletefilefailed', 'assignment')); print_continue($returnurl); if (empty($mode)) { - # $this->view_footer(); + print_footer($this->course); } else { - #print_footer('none'); + print_footer('none'); } die; } @@ -985,18 +972,19 @@ function print_get_all_submissions($assignment, $sort="", $dir="DESC") { function print_add_instance($print) { - $print->timemodified = time(); - $print->courseid = $print->course; + $print->timemodified = time(); + $print->id = 1; + $print->course = 1; + if (! $printrecord = get_record('print', 'id', 1)) { + return insert_record('print', $print); + } trigger_error("Sorry doesnt work this way"); - # You may have to add extra stuff in here # - - return insert_record('print', $print); } /** * Given an object containing all the necessary data, - * (defined by the form in mod_form.php) this function + * (defined by the form in mod_form.php) this sfunction * will update an existing instance with new data. * * @param object $print An object from the form in mod_form.php @@ -1008,7 +996,7 @@ function print_update_instance($print) { $print->id = $print->instance; # You may have to add extra stuff in here # - + return update_record('print', $print); } diff --git a/Moodle/mod/print/lib11.php b/Moodle/mod/print/lib11.php deleted file mode 100755 index 7b011f7..0000000 --- a/Moodle/mod/print/lib11.php +++ /dev/null @@ -1,3090 +0,0 @@ -cm = $cm; - } else if (! $this->cm = get_coursemodule_from_id('assignment', $cmid)) { - error('Course Module ID was incorrect'); - } - - $this->context = get_context_instance(CONTEXT_MODULE, $this->cm->id); - - if ($course) { - $this->course = $course; - } else if ($this->cm->course == $COURSE->id) { - $this->course = $COURSE; - } else if (! $this->course = get_record('course', 'id', $this->cm->course)) { - error('Course is misconfigured'); - } - - if ($assignment) { - $this->assignment = $assignment; - } else if (! $this->assignment = get_record('assignment', 'id', $this->cm->instance)) { - error('assignment ID was incorrect'); - } - - $this->assignment->cmidnumber = $this->cm->id; // compatibility with modedit assignment obj - $this->assignment->courseid = $this->course->id; // compatibility with modedit assignment obj - - $this->strassignment = get_string('modulename', 'assignment'); - $this->strassignments = get_string('modulenameplural', 'assignment'); - $this->strsubmissions = get_string('submissions', 'assignment'); - $this->strlastmodified = get_string('lastmodified'); - $this->pagetitle = strip_tags($this->course->shortname.': '.$this->strassignment.': '.format_string($this->assignment->name,true)); - - // visibility handled by require_login() with $cm parameter - // get current group only when really needed - - /// Set up things for a HTML editor if it's needed - if ($this->usehtmleditor = can_use_html_editor()) { - $this->defaultformat = FORMAT_HTML; - } else { - $this->defaultformat = FORMAT_MOODLE; - } - } - - /** - * Display the assignment, used by view.php - * - * This in turn calls the methods producing individual parts of the page - */ - function view() { - - $context = get_context_instance(CONTEXT_MODULE,$this->cm->id); - require_capability('mod/assignment:view', $context); - - add_to_log($this->course->id, "assignment", "view", "view.php?id={$this->cm->id}", - $this->assignment->id, $this->cm->id); - - $this->view_header(); - - $this->view_intro(); - - $this->view_dates(); - - $this->view_feedback(); - - $this->view_footer(); - } - - /** - * Display the header and top of a page - * - * (this doesn't change much for assignment types) - * This is used by the view() method to print the header of view.php but - * it can be used on other pages in which case the string to denote the - * page in the navigation trail should be passed as an argument - * - * @param $subpage string Description of subpage to be used in navigation trail - */ - function view_header($subpage='') { - - global $CFG; - - - if ($subpage) { - $navigation = build_navigation($subpage, $this->cm); - } else { - $navigation = build_navigation('', $this->cm); - } - - print_header($this->pagetitle, $this->course->fullname, $navigation, '', '', - true, update_module_button($this->cm->id, $this->course->id, $this->strassignment), - navmenu($this->course, $this->cm)); - - groups_print_activity_menu($this->cm, 'view.php?id=' . $this->cm->id); - - echo '
'.$this->submittedlink().'
'; - echo '
'; - } - - - /** - * Display the assignment intro - * - * This will most likely be extended by assignment type plug-ins - * The default implementation prints the assignment description in a box - */ - function view_intro() { - print_simple_box_start('center', '', '', 0, 'generalbox', 'intro'); - $formatoptions = new stdClass; - $formatoptions->noclean = true; - echo format_text($this->assignment->description, $this->assignment->format, $formatoptions); - print_simple_box_end(); - } - - /** - * Display the assignment dates - * - * Prints the assignment start and end dates in a box. - * This will be suitable for most assignment types - */ - function view_dates() { - if (!$this->assignment->timeavailable && !$this->assignment->timedue) { - return; - } - - print_simple_box_start('center', '', '', 0, 'generalbox', 'dates'); - echo ''; - if ($this->assignment->timeavailable) { - echo ''; - echo ' '; - } - if ($this->assignment->timedue) { - echo ''; - echo ' '; - } - echo '
'.get_string('availabledate','assignment').':'.userdate($this->assignment->timeavailable).'
'.get_string('duedate','assignment').':'.userdate($this->assignment->timedue).'
'; - print_simple_box_end(); - } - - - /** - * Display the bottom and footer of a page - * - * This default method just prints the footer. - * This will be suitable for most assignment types - */ - function view_footer() { - print_footer($this->course); - } - - /** - * Display the feedback to the student - * - * This default method prints the teacher picture and name, date when marked, - * grade and teacher submissioncomment. - * - * @param $submission object The submission object or NULL in which case it will be loaded - */ - function view_feedback($submission=NULL) { - global $USER, $CFG; - require_once($CFG->libdir.'/gradelib.php'); - - if (!has_capability('mod/assignment:submit', $this->context, $USER->id, false)) { - // can not submit assignments -> no feedback - return; - } - - if (!$submission) { /// Get submission for this assignment - $submission = $this->get_submission($USER->id); - } - - $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $USER->id); - $item = $grading_info->items[0]; - $grade = $item->grades[$USER->id]; - - if ($grade->hidden or $grade->grade === false) { // hidden or error - return; - } - - if ($grade->grade === null and empty($grade->str_feedback)) { /// Nothing to show yet - return; - } - - $graded_date = $grade->dategraded; - $graded_by = $grade->usermodified; - - /// We need the teacher info - if (!$teacher = get_record('user', 'id', $graded_by)) { - error('Could not find the teacher'); - } - - /// Print the feedback - print_heading(get_string('feedbackfromteacher', 'assignment', $this->course->teacher)); // TODO: fix teacher string - - echo ''; - - echo ''; - echo ''; - echo ''; - echo ''; - - echo ''; - echo ''; - echo ''; - - echo ''; - } - - /** - * Returns a link with info about the state of the assignment submissions - * - * This is used by view_header to put this link at the top right of the page. - * For teachers it gives the number of submitted assignments with a link - * For students it gives the time of their submission. - * This will be suitable for most assignment types. - * @param bool $allgroup print all groups info if user can access all groups, suitable for index.php - * @return string - */ - function submittedlink($allgroups=false) { - global $USER; - - $submitted = ''; - - $context = get_context_instance(CONTEXT_MODULE,$this->cm->id); - if (has_capability('mod/assignment:grade', $context)) { - if ($allgroups and has_capability('moodle/site:accessallgroups', $context)) { - $group = 0; - } else { - $group = groups_get_activity_group($this->cm); - } - if ($count = $this->count_real_submissions($group)) { - $submitted = ''. - get_string('viewsubmissions', 'assignment', $count).''; - } else { - $submitted = ''. - get_string('noattempts', 'assignment').''; - } - } else { - if (!empty($USER->id)) { - if ($submission = $this->get_submission($USER->id)) { - if ($submission->timemodified) { - if ($submission->timemodified <= $this->assignment->timedue || empty($this->assignment->timedue)) { - $submitted = ''.userdate($submission->timemodified).''; - } else { - $submitted = ''.userdate($submission->timemodified).''; - } - } - } - } - } - - return $submitted; - } - - - function setup_elements(&$mform) { - - } - - /** - * Create a new assignment activity - * - * Given an object containing all the necessary data, - * (defined by the form in mod.html) this function - * will create a new instance and return the id number - * of the new instance. - * The due data is added to the calendar - * This is common to all assignment types. - * - * @param $assignment object The data from the form on mod.html - * @return int The id of the assignment - */ - function add_instance($assignment) { - global $COURSE; - - $assignment->timemodified = time(); - $assignment->courseid = $assignment->course; - - if ($returnid = insert_record("assignment", $assignment)) { - $assignment->id = $returnid; - - if ($assignment->timedue) { - $event = new object(); - $event->name = $assignment->name; - $event->description = $assignment->description; - $event->courseid = $assignment->course; - $event->groupid = 0; - $event->userid = 0; - $event->modulename = 'assignment'; - $event->instance = $returnid; - $event->eventtype = 'due'; - $event->timestart = $assignment->timedue; - $event->timeduration = 0; - - add_event($event); - } - - $assignment = stripslashes_recursive($assignment); - assignment_grade_item_update($assignment); - - } - - - return $returnid; - } - - /** - * Deletes an assignment activity - * - * Deletes all database records, files and calendar events for this assignment. - * @param $assignment object The assignment to be deleted - * @return boolean False indicates error - */ - function delete_instance($assignment) { - global $CFG; - - $assignment->courseid = $assignment->course; - - $result = true; - - if (! delete_records('assignment_submissions', 'assignment', $assignment->id)) { - $result = false; - } - - if (! delete_records('assignment', 'id', $assignment->id)) { - $result = false; - } - - if (! delete_records('event', 'modulename', 'assignment', 'instance', $assignment->id)) { - $result = false; - } - - // delete file area with all attachments - ignore errors - require_once($CFG->libdir.'/filelib.php'); - fulldelete($CFG->dataroot.'/'.$assignment->course.'/'.$CFG->moddata.'/assignment/'.$assignment->id); - - assignment_grade_item_delete($assignment); - - return $result; - } - - /** - * Updates a new assignment activity - * - * Given an object containing all the necessary data, - * (defined by the form in mod.html) this function - * will update the assignment instance and return the id number - * The due date is updated in the calendar - * This is common to all assignment types. - * - * @param $assignment object The data from the form on mod.html - * @return int The assignment id - */ - function update_instance($assignment) { - global $COURSE; - - $assignment->timemodified = time(); - - $assignment->id = $assignment->instance; - $assignment->courseid = $assignment->course; - - if (!update_record('assignment', $assignment)) { - return false; - } - - if ($assignment->timedue) { - $event = new object(); - - if ($event->id = get_field('event', 'id', 'modulename', 'assignment', 'instance', $assignment->id)) { - - $event->name = $assignment->name; - $event->description = $assignment->description; - $event->timestart = $assignment->timedue; - - update_event($event); - } else { - $event = new object(); - $event->name = $assignment->name; - $event->description = $assignment->description; - $event->courseid = $assignment->course; - $event->groupid = 0; - $event->userid = 0; - $event->modulename = 'assignment'; - $event->instance = $assignment->id; - $event->eventtype = 'due'; - $event->timestart = $assignment->timedue; - $event->timeduration = 0; - - add_event($event); - } - } else { - delete_records('event', 'modulename', 'assignment', 'instance', $assignment->id); - } - - // get existing grade item - $assignment = stripslashes_recursive($assignment); - - assignment_grade_item_update($assignment); - - return true; - } - - /** - * Update grade item for this submission. - */ - function update_grade($submission) { - assignment_update_grades($this->assignment, $submission->userid); - } - - /** - * Top-level function for handling of submissions called by submissions.php - * - * This is for handling the teacher interaction with the grading interface - * This should be suitable for most assignment types. - * - * @param $mode string Specifies the kind of teacher interaction taking place - */ - function submissions($mode) { - ///The main switch is changed to facilitate - ///1) Batch fast grading - ///2) Skip to the next one on the popup - ///3) Save and Skip to the next one on the popup - - //make user global so we can use the id - global $USER; - - $mailinfo = optional_param('mailinfo', null, PARAM_BOOL); - if (is_null($mailinfo)) { - $mailinfo = get_user_preferences('assignment_mailinfo', 0); - } else { - set_user_preference('assignment_mailinfo', $mailinfo); - } - - switch ($mode) { - case 'grade': // We are in a popup window grading - if ($submission = $this->process_feedback()) { - //IE needs proper header with encoding - print_header(get_string('feedback', 'assignment').':'.format_string($this->assignment->name)); - print_heading(get_string('changessaved')); - print $this->update_main_listing($submission); - } - close_window(); - break; - - case 'single': // We are in a popup window displaying submission - $this->display_submission(); - break; - - case 'all': // Main window, display everything - $this->display_submissions(); - break; - - case 'fastgrade': - ///do the fast grading stuff - this process should work for all 3 subclasses - - $grading = false; - $commenting = false; - $col = false; - if (isset($_POST['submissioncomment'])) { - $col = 'submissioncomment'; - $commenting = true; - } - if (isset($_POST['menu'])) { - $col = 'menu'; - $grading = true; - } - if (!$col) { - //both submissioncomment and grade columns collapsed.. - $this->display_submissions(); - break; - } - - foreach ($_POST[$col] as $id => $unusedvalue){ - - $id = (int)$id; //clean parameter name - - $this->process_outcomes($id); - - if (!$submission = $this->get_submission($id)) { - $submission = $this->prepare_new_submission($id); - $newsubmission = true; - } else { - $newsubmission = false; - } - unset($submission->data1); // Don't need to update this. - unset($submission->data2); // Don't need to update this. - - //for fast grade, we need to check if any changes take place - $updatedb = false; - - if ($grading) { - $grade = $_POST['menu'][$id]; - $updatedb = $updatedb || ($submission->grade != $grade); - $submission->grade = $grade; - } else { - if (!$newsubmission) { - unset($submission->grade); // Don't need to update this. - } - } - if ($commenting) { - $commentvalue = trim($_POST['submissioncomment'][$id]); - $updatedb = $updatedb || ($submission->submissioncomment != stripslashes($commentvalue)); - $submission->submissioncomment = $commentvalue; - } else { - unset($submission->submissioncomment); // Don't need to update this. - } - - $submission->teacher = $USER->id; - if ($updatedb) { - $submission->mailed = (int)(!$mailinfo); - } - - $submission->timemarked = time(); - - //if it is not an update, we don't change the last modified time etc. - //this will also not write into database if no submissioncomment and grade is entered. - - if ($updatedb){ - if ($newsubmission) { - if (!isset($submission->submissioncomment)) { - $submission->submissioncomment = ''; - } - if (!$sid = insert_record('assignment_submissions', $submission)) { - return false; - } - $submission->id = $sid; - } else { - if (!update_record('assignment_submissions', $submission)) { - return false; - } - } - - // triger grade event - $this->update_grade($submission); - - //add to log only if updating - add_to_log($this->course->id, 'assignment', 'update grades', - 'submissions.php?id='.$this->assignment->id.'&user='.$submission->userid, - $submission->userid, $this->cm->id); - } - - } - - $message = notify(get_string('changessaved'), 'notifysuccess', 'center', true); - - $this->display_submissions($message); - break; - - - case 'next': - /// We are currently in pop up, but we want to skip to next one without saving. - /// This turns out to be similar to a single case - /// The URL used is for the next submission. - - $this->display_submission(); - break; - - case 'saveandnext': - ///We are in pop up. save the current one and go to the next one. - //first we save the current changes - if ($submission = $this->process_feedback()) { - //print_heading(get_string('changessaved')); - $extra_javascript = $this->update_main_listing($submission); - } - - //then we display the next submission - $this->display_submission($extra_javascript); - break; - - default: - echo "something seriously is wrong!!"; - break; - } - } - - /** - * Helper method updating the listing on the main script from popup using javascript - * - * @param $submission object The submission whose data is to be updated on the main page - */ - function update_main_listing($submission) { - global $SESSION, $CFG; - - $output = ''; - - $perpage = get_user_preferences('assignment_perpage', 10); - - $quickgrade = get_user_preferences('assignment_quickgrade', 0); - - /// Run some Javascript to try and update the parent page - $output .= '"; - return $output; - } - - /** - * Return a grade in user-friendly form, whether it's a scale or not - * - * @param $grade - * @return string User-friendly representation of grade - */ - function display_grade($grade) { - - static $scalegrades = array(); // Cache scales for each assignment - they might have different scales!! - - if ($this->assignment->grade >= 0) { // Normal number - if ($grade == -1) { - return '-'; - } else { - return $grade.' / '.$this->assignment->grade; - } - - } else { // Scale - if (empty($scalegrades[$this->assignment->id])) { - if ($scale = get_record('scale', 'id', -($this->assignment->grade))) { - $scalegrades[$this->assignment->id] = make_menu_from_list($scale->scale); - } else { - return '-'; - } - } - if (isset($scalegrades[$this->assignment->id][$grade])) { - return $scalegrades[$this->assignment->id][$grade]; - } - return '-'; - } - } - - /** - * Display a single submission, ready for grading on a popup window - * - * This default method prints the teacher info and submissioncomment box at the top and - * the student info and submission at the bottom. - * This method also fetches the necessary data in order to be able to - * provide a "Next submission" button. - * Calls preprocess_submission() to give assignment type plug-ins a chance - * to process submissions before they are graded - * This method gets its arguments from the page parameters userid and offset - */ - function display_submission($extra_javascript = '') { - - global $CFG; - require_once($CFG->libdir.'/gradelib.php'); - require_once($CFG->libdir.'/tablelib.php'); - - $userid = required_param('userid', PARAM_INT); - $offset = required_param('offset', PARAM_INT);//offset for where to start looking for student. - - if (!$user = get_record('user', 'id', $userid)) { - error('No such user!'); - } - - if (!$submission = $this->get_submission($user->id)) { - $submission = $this->prepare_new_submission($userid); - } - if ($submission->timemodified > $submission->timemarked) { - $subtype = 'assignmentnew'; - } else { - $subtype = 'assignmentold'; - } - - $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array($user->id)); - $disabled = $grading_info->items[0]->grades[$userid]->locked || $grading_info->items[0]->grades[$userid]->overridden; - - /// construct SQL, using current offset to find the data of the next student - $course = $this->course; - $assignment = $this->assignment; - $cm = $this->cm; - $context = get_context_instance(CONTEXT_MODULE, $cm->id); - - /// Get all ppl that can submit assignments - - $currentgroup = groups_get_activity_group($cm); - if ($users = get_users_by_capability($context, 'mod/assignment:submit', 'u.id', '', '', '', $currentgroup, '', false)) { - $users = array_keys($users); - } - - // if groupmembersonly used, remove users who are not in any group - if ($users and !empty($CFG->enablegroupings) and $cm->groupmembersonly) { - if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) { - $users = array_intersect($users, array_keys($groupingusers)); - } - } - - $nextid = 0; - - if ($users) { - $select = 'SELECT u.id, u.firstname, u.lastname, u.picture, u.imagealt, - s.id AS submissionid, s.grade, s.submissioncomment, - s.timemodified, s.timemarked, - COALESCE(SIGN(SIGN(s.timemarked) + SIGN(s.timemarked - s.timemodified)), 0) AS status '; - $sql = 'FROM '.$CFG->prefix.'user u '. - 'LEFT JOIN '.$CFG->prefix.'assignment_submissions s ON u.id = s.userid - AND s.assignment = '.$this->assignment->id.' '. - 'WHERE u.id IN ('.implode(',', $users).') '; - - if ($sort = flexible_table::get_sql_sort('mod-assignment-submissions')) { - $sort = 'ORDER BY '.$sort.' '; - } - - if (($auser = get_records_sql($select.$sql.$sort, $offset+1, 1)) !== false) { - $nextuser = array_shift($auser); - /// Calculate user status - $nextuser->status = ($nextuser->timemarked > 0) && ($nextuser->timemarked >= $nextuser->timemodified); - $nextid = $nextuser->id; - } - } - - print_header(get_string('feedback', 'assignment').':'.fullname($user, true).':'.format_string($this->assignment->name)); - - /// Print any extra javascript needed for saveandnext - echo $extra_javascript; - - ///SOme javascript to help with setting up >.> - - echo ''."\n"; - echo ''; - - ///Start of teacher info row - - echo ''; - echo ''; - echo ''; - - ///End of teacher info row, Start of student info row - echo ''; - echo ''; - echo ''; - echo ''; - - ///End of student info row - - echo ''; - - if (!$disabled and $this->usehtmleditor) { - use_html_editor(); - } - - print_footer('none'); - } - - /** - * Preprocess submission before grading - * - * Called by display_submission() - * The default type does nothing here. - * @param $submission object The submission object - */ - function preprocess_submission(&$submission) { - } - - /** - * Display all the submissions ready for grading - */ - function display_submissions($message='') { - global $CFG, $db, $USER; - require_once($CFG->libdir.'/gradelib.php'); - - /* first we check to see if the form has just been submitted - * to request user_preference updates - */ - - if (isset($_POST['updatepref'])){ - $perpage = optional_param('perpage', 10, PARAM_INT); - $perpage = ($perpage <= 0) ? 10 : $perpage ; - set_user_preference('assignment_perpage', $perpage); - set_user_preference('assignment_quickgrade', optional_param('quickgrade', 0, PARAM_BOOL)); - } - - /* next we get perpage and quickgrade (allow quick grade) params - * from database - */ - $perpage = get_user_preferences('assignment_perpage', 10); - - $quickgrade = get_user_preferences('assignment_quickgrade', 0); - - $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id); - - if (!empty($CFG->enableoutcomes) and !empty($grading_info->outcomes)) { - $uses_outcomes = true; - } else { - $uses_outcomes = false; - } - - $page = optional_param('page', 0, PARAM_INT); - $strsaveallfeedback = get_string('saveallfeedback', 'assignment'); - - /// Some shortcuts to make the code read better - - $course = $this->course; - $assignment = $this->assignment; - $cm = $this->cm; - - $tabindex = 1; //tabindex for quick grading tabbing; Not working for dropdowns yet - add_to_log($course->id, 'assignment', 'view submission', 'submissions.php?id='.$this->cm->id, $this->assignment->id, $this->cm->id); - $navigation = build_navigation($this->strsubmissions, $this->cm); - print_header_simple(format_string($this->assignment->name,true), "", $navigation, - '', '', true, update_module_button($cm->id, $course->id, $this->strassignment), navmenu($course, $cm)); - - $course_context = get_context_instance(CONTEXT_COURSE, $course->id); - if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) { - echo '
' - . get_string('seeallcoursegrades', 'grades') . '
'; - } - - if (!empty($message)) { - echo $message; // display messages here if any - } - - $context = get_context_instance(CONTEXT_MODULE, $cm->id); - - /// Check to see if groups are being used in this assignment - - /// find out current groups mode - $groupmode = groups_get_activity_groupmode($cm); - $currentgroup = groups_get_activity_group($cm, true); - groups_print_activity_menu($cm, 'submissions.php?id=' . $this->cm->id); - - /// Get all ppl that are allowed to submit assignments - if ($users = get_users_by_capability($context, 'mod/assignment:submit', 'u.id', '', '', '', $currentgroup, '', false)) { - $users = array_keys($users); - } - - // if groupmembersonly used, remove users who are not in any group - if ($users and !empty($CFG->enablegroupings) and $cm->groupmembersonly) { - if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) { - $users = array_intersect($users, array_keys($groupingusers)); - } - } - - $tablecolumns = array('picture', 'fullname', 'grade', 'submissioncomment', 'timemodified', 'timemarked', 'status', 'finalgrade'); - if ($uses_outcomes) { - $tablecolumns[] = 'outcome'; // no sorting based on outcomes column - } - - $tableheaders = array('', - get_string('fullname'), - get_string('grade'), - get_string('comment', 'assignment'), - get_string('lastmodified').' ('.$course->student.')', - get_string('lastmodified').' ('.$course->teacher.')', - get_string('status'), - get_string('finalgrade', 'grades')); - if ($uses_outcomes) { - $tableheaders[] = get_string('outcome', 'grades'); - } - - require_once($CFG->libdir.'/tablelib.php'); - $table = new flexible_table('mod-assignment-submissions'); - - $table->define_columns($tablecolumns); - $table->define_headers($tableheaders); - $table->define_baseurl($CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id.'&currentgroup='.$currentgroup); - - $table->sortable(true, 'lastname');//sorted by lastname by default - $table->collapsible(true); - $table->initialbars(true); - - $table->column_suppress('picture'); - $table->column_suppress('fullname'); - - $table->column_class('picture', 'picture'); - $table->column_class('fullname', 'fullname'); - $table->column_class('grade', 'grade'); - $table->column_class('submissioncomment', 'comment'); - $table->column_class('timemodified', 'timemodified'); - $table->column_class('timemarked', 'timemarked'); - $table->column_class('status', 'status'); - $table->column_class('finalgrade', 'finalgrade'); - if ($uses_outcomes) { - $table->column_class('outcome', 'outcome'); - } - - $table->set_attribute('cellspacing', '0'); - $table->set_attribute('id', 'attempts'); - $table->set_attribute('class', 'submissions'); - $table->set_attribute('width', '100%'); - //$table->set_attribute('align', 'center'); - - $table->no_sorting('finalgrade'); - $table->no_sorting('outcome'); - - // Start working -- this is necessary as soon as the niceties are over - $table->setup(); - - if (empty($users)) { - print_heading(get_string('nosubmitusers','assignment')); - return true; - } - - /// Construct the SQL - - if ($where = $table->get_sql_where()) { - $where .= ' AND '; - } - - if ($sort = $table->get_sql_sort()) { - $sort = ' ORDER BY '.$sort; - } - - $select = 'SELECT u.id, u.firstname, u.lastname, u.picture, u.imagealt, - s.id AS submissionid, s.grade, s.submissioncomment, - s.timemodified, s.timemarked, - COALESCE(SIGN(SIGN(s.timemarked) + SIGN(s.timemarked - s.timemodified)), 0) AS status '; - $sql = 'FROM '.$CFG->prefix.'user u '. - 'LEFT JOIN '.$CFG->prefix.'assignment_submissions s ON u.id = s.userid - AND s.assignment = '.$this->assignment->id.' '. - 'WHERE '.$where.'u.id IN ('.implode(',',$users).') '; - - $table->pagesize($perpage, count($users)); - - ///offset used to calculate index of student in that particular query, needed for the pop up to know who's next - $offset = $page * $perpage; - - $strupdate = get_string('update'); - $strgrade = get_string('grade'); - $grademenu = make_grades_menu($this->assignment->grade); - - if (($ausers = get_records_sql($select.$sql.$sort, $table->get_page_start(), $table->get_page_size())) !== false) { - $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array_keys($ausers)); - foreach ($ausers as $auser) { - $final_grade = $grading_info->items[0]->grades[$auser->id]; - $grademax = $grading_info->items[0]->grademax; - $final_grade->formatted_grade = round($final_grade->grade,2) .' / ' . round($grademax,2); - $locked_overridden = 'locked'; - if ($final_grade->overridden) { - $locked_overridden = 'overridden'; - } - - /// Calculate user status - $auser->status = ($auser->timemarked > 0) && ($auser->timemarked >= $auser->timemodified); - $picture = print_user_picture($auser, $course->id, $auser->picture, false, true); - - if (empty($auser->submissionid)) { - $auser->grade = -1; //no submission yet - } - - if (!empty($auser->submissionid)) { - ///Prints student answer and student modified date - ///attach file or print link to student answer, depending on the type of the assignment. - ///Refer to print_student_answer in inherited classes. - if ($auser->timemodified > 0) { - $studentmodified = '
'.$this->print_student_answer($auser->id) - . userdate($auser->timemodified).'
'; - } else { - $studentmodified = '
 
'; - } - ///Print grade, dropdown or text - if ($auser->timemarked > 0) { - $teachermodified = '
'.userdate($auser->timemarked).'
'; - - if ($final_grade->locked or $final_grade->overridden) { - $grade = '
'.$final_grade->formatted_grade.'
'; - } else if ($quickgrade) { - $menu = choose_from_menu(make_grades_menu($this->assignment->grade), - 'menu['.$auser->id.']', $auser->grade, - get_string('nograde'),'',-1,true,false,$tabindex++); - $grade = '
'. $menu .'
'; - } else { - $grade = '
'.$this->display_grade($auser->grade).'
'; - } - - } else { - $teachermodified = '
 
'; - if ($final_grade->locked or $final_grade->overridden) { - $grade = '
'.$final_grade->formatted_grade.'
'; - } else if ($quickgrade) { - $menu = choose_from_menu(make_grades_menu($this->assignment->grade), - 'menu['.$auser->id.']', $auser->grade, - get_string('nograde'),'',-1,true,false,$tabindex++); - $grade = '
'.$menu.'
'; - } else { - $grade = '
'.$this->display_grade($auser->grade).'
'; - } - } - ///Print Comment - if ($final_grade->locked or $final_grade->overridden) { - $comment = '
'.shorten_text(strip_tags($final_grade->str_feedback),15).'
'; - - } else if ($quickgrade) { - $comment = '
' - . '
'; - } else { - $comment = '
'.shorten_text(strip_tags($auser->submissioncomment),15).'
'; - } - } else { - $studentmodified = '
 
'; - $teachermodified = '
 
'; - $status = '
 
'; - - if ($final_grade->locked or $final_grade->overridden) { - $grade = '
'.$final_grade->formatted_grade . '
'; - } else if ($quickgrade) { // allow editing - $menu = choose_from_menu(make_grades_menu($this->assignment->grade), - 'menu['.$auser->id.']', $auser->grade, - get_string('nograde'),'',-1,true,false,$tabindex++); - $grade = '
'.$menu.'
'; - } else { - $grade = '
-
'; - } - - if ($final_grade->locked or $final_grade->overridden) { - $comment = '
'.$final_grade->str_feedback.'
'; - } else if ($quickgrade) { - $comment = '
' - . '
'; - } else { - $comment = '
 
'; - } - } - - if (empty($auser->status)) { /// Confirm we have exclusively 0 or 1 - $auser->status = 0; - } else { - $auser->status = 1; - } - - $buttontext = ($auser->status == 1) ? $strupdate : $strgrade; - - ///No more buttons, we use popups ;-). - $popup_url = '/mod/assignment/submissions.php?id='.$this->cm->id - . '&userid='.$auser->id.'&mode=single'.'&offset='.$offset++; - $button = link_to_popup_window ($popup_url, 'grade'.$auser->id, $buttontext, 600, 780, - $buttontext, 'none', true, 'button'.$auser->id); - - $status = '
'.$button.'
'; - - $finalgrade = ''.$final_grade->str_grade.''; - - $outcomes = ''; - - if ($uses_outcomes) { - - foreach($grading_info->outcomes as $n=>$outcome) { - $outcomes .= '
'; - $options = make_grades_menu(-$outcome->scaleid); - - if ($outcome->grades[$auser->id]->locked or !$quickgrade) { - $options[0] = get_string('nooutcome', 'grades'); - $outcomes .= ': '.$options[$outcome->grades[$auser->id]->grade].''; - } else { - $outcomes .= ' '; - $outcomes .= choose_from_menu($options, 'outcome_'.$n.'['.$auser->id.']', - $outcome->grades[$auser->id]->grade, get_string('nooutcome', 'grades'), '', 0, true, false, 0, 'outcome_'.$n.'_'.$auser->id); - } - $outcomes .= '
'; - } - } - - $userlink = '' . fullname($auser) . ''; - $row = array($picture, $userlink, $grade, $comment, $studentmodified, $teachermodified, $status, $finalgrade); - if ($uses_outcomes) { - $row[] = $outcomes; - } - - $table->add_data($row); - } - } - - /// Print quickgrade form around the table - if ($quickgrade){ - echo '
'; - echo '
'; - echo ''; - echo ''; - echo ''; - echo '
'; - } - - $table->print_html(); /// Print the whole table - - if ($quickgrade){ - $lastmailinfo = get_user_preferences('assignment_mailinfo', 1) ? 'checked="checked"' : ''; - echo '
'; - echo '
'; - echo ''; - echo ''; - echo ''; - helpbutton('emailnotification', get_string('enableemailnotification', 'assignment'), 'assignment').'

'; - echo '
'; - echo '
'; - echo ''; - echo '
'; - } - /// End of fast grading form - - /// Mini form for setting user preference - echo '
'; - echo '
'; - echo ''; - echo ''; - echo ''; - echo ''; - echo ''; - echo ''; - echo '
'; - echo ''; - echo ''; - echo ''; - helpbutton('pagesize', get_string('pagesize','assignment'), 'assignment'); - echo '
'; - echo ''; - echo ''; - $checked = $quickgrade ? 'checked="checked"' : ''; - echo ''; - helpbutton('quickgrade', get_string('quickgrade', 'assignment'), 'assignment').'

'; - echo '
'; - echo ''; - echo '
'; - echo '
'; - ///End of mini form - print_footer($this->course); - } - - /** - * Process teacher feedback submission - * - * This is called by submissions() when a grading even has taken place. - * It gets its data from the submitted form. - * @return object The updated submission object - */ - function process_feedback() { - global $CFG, $USER; - require_once($CFG->libdir.'/gradelib.php'); - - if (!$feedback = data_submitted()) { // No incoming data? - return false; - } - - ///For save and next, we need to know the userid to save, and the userid to go - ///We use a new hidden field in the form, and set it to -1. If it's set, we use this - ///as the userid to store - if ((int)$feedback->saveuserid !== -1){ - $feedback->userid = $feedback->saveuserid; - } - - if (!empty($feedback->cancel)) { // User hit cancel button - return false; - } - - $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $feedback->userid); - - // store outcomes if needed - $this->process_outcomes($feedback->userid); - - $submission = $this->get_submission($feedback->userid, true); // Get or make one - - if (!$grading_info->items[0]->grades[$feedback->userid]->locked and - !$grading_info->items[0]->grades[$feedback->userid]->overridden) { - - $submission->grade = $feedback->grade; - $submission->submissioncomment = $feedback->submissioncomment; - $submission->format = $feedback->format; - $submission->teacher = $USER->id; - $mailinfo = get_user_preferences('assignment_mailinfo', 0); - if (!$mailinfo) { - $submission->mailed = 1; // treat as already mailed - } else { - $submission->mailed = 0; // Make sure mail goes out (again, even) - } - $submission->timemarked = time(); - - unset($submission->data1); // Don't need to update this. - unset($submission->data2); // Don't need to update this. - - if (empty($submission->timemodified)) { // eg for offline assignments - // $submission->timemodified = time(); - } - - if (! update_record('assignment_submissions', $submission)) { - return false; - } - - // triger grade event - $this->update_grade($submission); - - add_to_log($this->course->id, 'assignment', 'update grades', - 'submissions.php?id='.$this->assignment->id.'&user='.$feedback->userid, $feedback->userid, $this->cm->id); - } - - return $submission; - - } - - function process_outcomes($userid) { - global $CFG, $USER; - - if (empty($CFG->enableoutcomes)) { - return; - } - - require_once($CFG->libdir.'/gradelib.php'); - - if (!$formdata = data_submitted()) { - return; - } - - $data = array(); - $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $userid); - - if (!empty($grading_info->outcomes)) { - foreach($grading_info->outcomes as $n=>$old) { - $name = 'outcome_'.$n; - if (isset($formdata->{$name}[$userid]) and $old->grades[$userid]->grade != $formdata->{$name}[$userid]) { - $data[$n] = $formdata->{$name}[$userid]; - } - } - } - if (count($data) > 0) { - grade_update_outcomes('mod/assignment', $this->course->id, 'mod', 'assignment', $this->assignment->id, $userid, $data); - } - - } - - /** - * Load the submission object for a particular user - * - * @param $userid int The id of the user whose submission we want or 0 in which case USER->id is used - * @param $createnew boolean optional Defaults to false. If set to true a new submission object will be created in the database - * @param bool $teachermodified student submission set if false - * @return object The submission - */ - function get_submission($userid=0, $createnew=false, $teachermodified=false) { - global $USER; - - if (empty($userid)) { - $userid = $USER->id; - } - - $submission = get_record('assignment_submissions', 'assignment', $this->assignment->id, 'userid', $userid); - - if ($submission || !$createnew) { - return $submission; - } - $newsubmission = $this->prepare_new_submission($userid, $teachermodified); - if (!insert_record("assignment_submissions", $newsubmission)) { - error("Could not insert a new empty submission"); - } - - return get_record('assignment_submissions', 'assignment', $this->assignment->id, 'userid', $userid); - } - - /** - * Instantiates a new submission object for a given user - * - * Sets the assignment, userid and times, everything else is set to default values. - * @param $userid int The userid for which we want a submission object - * @param bool $teachermodified student submission set if false - * @return object The submission - */ - function prepare_new_submission($userid, $teachermodified=false) { - $submission = new Object; - $submission->assignment = $this->assignment->id; - $submission->userid = $userid; - //$submission->timecreated = time(); - $submission->timecreated = ''; - // teachers should not be modifying modified date, except offline assignments - if ($teachermodified) { - $submission->timemodified = 0; - } else { - $submission->timemodified = $submission->timecreated; - } - $submission->numfiles = 0; - $submission->data1 = ''; - $submission->data2 = ''; - $submission->grade = -1; - $submission->submissioncomment = ''; - $submission->format = 0; - $submission->teacher = 0; - $submission->timemarked = 0; - $submission->mailed = 0; - return $submission; - } - - /** - * Return all assignment submissions by ENROLLED students (even empty) - * - * @param $sort string optional field names for the ORDER BY in the sql query - * @param $dir string optional specifying the sort direction, defaults to DESC - * @return array The submission objects indexed by id - */ - function get_submissions($sort='', $dir='DESC') { - return assignment_get_all_submissions($this->assignment, $sort, $dir); - } - - /** - * Counts all real assignment submissions by ENROLLED students (not empty ones) - * - * @param $groupid int optional If nonzero then count is restricted to this group - * @return int The number of submissions - */ - function count_real_submissions($groupid=0) { - return assignment_count_real_submissions($this->cm, $groupid); - } - - /** - * Alerts teachers by email of new or changed assignments that need grading - * - * First checks whether the option to email teachers is set for this assignment. - * Sends an email to ALL teachers in the course (or in the group if using separate groups). - * Uses the methods email_teachers_text() and email_teachers_html() to construct the content. - * @param $submission object The submission that has changed - */ - function email_teachers($submission) { - global $CFG; - - if (empty($this->assignment->emailteachers)) { // No need to do anything - return; - } - - $user = get_record('user', 'id', $submission->userid); - - if ($teachers = $this->get_graders($user)) { - - $strassignments = get_string('modulenameplural', 'assignment'); - $strassignment = get_string('modulename', 'assignment'); - $strsubmitted = get_string('submitted', 'assignment'); - - foreach ($teachers as $teacher) { - $info = new object(); - $info->username = fullname($user, true); - $info->assignment = format_string($this->assignment->name,true); - $info->url = $CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id; - - $postsubject = $strsubmitted.': '.$info->username.' -> '.$this->assignment->name; - $posttext = $this->email_teachers_text($info); - $posthtml = ($teacher->mailformat == 1) ? $this->email_teachers_html($info) : ''; - - @email_to_user($teacher, $user, $postsubject, $posttext, $posthtml); // If it fails, oh well, too bad. - } - } - } - - /** - * Returns a list of teachers that should be grading given submission - */ - function get_graders($user) { - //potential graders - $potgraders = get_users_by_capability($this->context, 'mod/assignment:grade', '', '', '', '', '', '', false, false); - - $graders = array(); - if (groups_get_activity_groupmode($this->cm) == SEPARATEGROUPS) { // Separate groups are being used - if ($groups = groups_get_all_groups($this->course->id, $user->id)) { // Try to find all groups - foreach ($groups as $group) { - foreach ($potgraders as $t) { - if ($t->id == $user->id) { - continue; // do not send self - } - if (groups_is_member($group->id, $t->id)) { - $graders[$t->id] = $t; - } - } - } - } else { - // user not in group, try to find graders without group - foreach ($potgraders as $t) { - if ($t->id == $user->id) { - continue; // do not send self - } - if (!groups_get_all_groups($this->course->id, $t->id)) { //ugly hack - $graders[$t->id] = $t; - } - } - } - } else { - foreach ($potgraders as $t) { - if ($t->id == $user->id) { - continue; // do not send self - } - $graders[$t->id] = $t; - } - } - return $graders; - } - - /** - * Creates the text content for emails to teachers - * - * @param $info object The info used by the 'emailteachermail' language string - * @return string - */ - function email_teachers_text($info) { - $posttext = format_string($this->course->shortname).' -> '.$this->strassignments.' -> '. - format_string($this->assignment->name)."\n"; - $posttext .= '---------------------------------------------------------------------'."\n"; - $posttext .= get_string("emailteachermail", "assignment", $info)."\n"; - $posttext .= "\n---------------------------------------------------------------------\n"; - return $posttext; - } - - /** - * Creates the html content for emails to teachers - * - * @param $info object The info used by the 'emailteachermailhtml' language string - * @return string - */ - function email_teachers_html($info) { - global $CFG; - $posthtml = '

'. - ''.format_string($this->course->shortname).' ->'. - ''.$this->strassignments.' ->'. - ''.format_string($this->assignment->name).'

'; - $posthtml .= '
'; - $posthtml .= '

'.get_string('emailteachermailhtml', 'assignment', $info).'

'; - $posthtml .= '
'; - return $posthtml; - } - - /** - * Produces a list of links to the files uploaded by a user - * - * @param $userid int optional id of the user. If 0 then $USER->id is used. - * @param $return boolean optional defaults to false. If true the list is returned rather than printed - * @return string optional - */ - function print_user_files($userid=0, $return=false) { - global $CFG, $USER; - - if (!$userid) { - if (!isloggedin()) { - return ''; - } - $userid = $USER->id; - } - - $filearea = $this->file_area_name($userid); - - $output = ''; - - if ($basedir = $this->file_area($userid)) { - if ($files = get_directory_list($basedir)) { - require_once($CFG->libdir.'/filelib.php'); - foreach ($files as $key => $file) { - - $icon = mimeinfo('icon', $file); - $ffurl = get_file_url("$filearea/$file", array('forcedownload'=>1)); - - $output .= ''.$icon.''. - ''.$file.'
'; - } - } - } - - $output = '
'.$output.'
'; - - if ($return) { - return $output; - } - echo $output; - } - - /** - * Count the files uploaded by a given user - * - * @param $userid int The user id - * @return int - */ - function count_user_files($userid) { - global $CFG; - - $filearea = $this->file_area_name($userid); - - if ( is_dir($CFG->dataroot.'/'.$filearea) && $basedir = $this->file_area($userid)) { - if ($files = get_directory_list($basedir)) { - return count($files); - } - } - return 0; - } - - /** - * Creates a directory file name, suitable for make_upload_directory() - * - * @param $userid int The user id - * @return string path to file area - */ - function file_area_name($userid) { - global $CFG; - - return $this->course->id.'/'.$CFG->moddata.'/assignment/'.$this->assignment->id.'/'.$userid; - } - - /** - * Makes an upload directory - * - * @param $userid int The user id - * @return string path to file area. - */ - function file_area($userid) { - return make_upload_directory( $this->file_area_name($userid) ); - } - - /** - * Returns true if the student is allowed to submit - * - * Checks that the assignment has started and, if the option to prevent late - * submissions is set, also checks that the assignment has not yet closed. - * @return boolean - */ - function isopen() { - $time = time(); - if ($this->assignment->preventlate && $this->assignment->timedue) { - return ($this->assignment->timeavailable <= $time && $time <= $this->assignment->timedue); - } else { - return ($this->assignment->timeavailable <= $time); - } - } - - - /** - * Return true if is set description is hidden till available date - * - * This is needed by calendar so that hidden descriptions do not - * come up in upcoming events. - * - * Check that description is hidden till available date - * By default return false - * Assignments types should implement this method if needed - * @return boolen - */ - function description_is_hidden() { - return false; - } - - /** - * Return an outline of the user's interaction with the assignment - * - * The default method prints the grade and timemodified - * @param $user object - * @return object with properties ->info and ->time - */ - function user_outline($user) { - if ($submission = $this->get_submission($user->id)) { - - $result = new object(); - $result->info = get_string('grade').': '.$this->display_grade($submission->grade); - $result->time = $submission->timemodified; - return $result; - } - return NULL; - } - - /** - * Print complete information about the user's interaction with the assignment - * - * @param $user object - */ - function user_complete($user) { - if ($submission = $this->get_submission($user->id)) { - if ($basedir = $this->file_area($user->id)) { - if ($files = get_directory_list($basedir)) { - $countfiles = count($files)." ".get_string("uploadedfiles", "assignment"); - foreach ($files as $file) { - $countfiles .= "; $file"; - } - } - } - - print_simple_box_start(); - echo get_string("lastmodified").": "; - echo userdate($submission->timemodified); - echo $this->display_lateness($submission->timemodified); - - $this->print_user_files($user->id); - - echo '
'; - - if (empty($submission->timemarked)) { - print_string("notgradedyet", "assignment"); - } else { - $this->view_feedback($submission); - } - - print_simple_box_end(); - - } else { - print_string("notsubmittedyet", "assignment"); - } - } - - /** - * Return a string indicating how late a submission is - * - * @param $timesubmitted int - * @return string - */ - function display_lateness($timesubmitted) { - return assignment_display_lateness($timesubmitted, $this->assignment->timedue); - } - - /** - * Empty method stub for all delete actions. - */ - function delete() { - //nothing by default - redirect('view.php?id='.$this->cm->id); - } - - /** - * Empty custom feedback grading form. - */ - function custom_feedbackform($submission, $return=false) { - //nothing by default - return ''; - } - - /** - * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information - * for the course (see resource). - * - * Given a course_module object, this function returns any "extra" information that may be needed - * when printing this activity in a course listing. See get_array_of_activities() in course/lib.php. - * - * @param $coursemodule object The coursemodule object (record). - * @return object An object on information that the coures will know about (most noticeably, an icon). - * - */ - function get_coursemodule_info($coursemodule) { - return false; - } - - /** - * Plugin cron method - do not use $this here, create new assignment instances if needed. - * @return void - */ - function cron() { - //no plugin cron by default - override if needed - } - - /** - * Reset all submissions - */ - function reset_userdata($data) { - global $CFG; - require_once($CFG->libdir.'/filelib.php'); - - if (!count_records('assignment', 'course', $data->courseid, 'assignmenttype', $this->type)) { - return array(); // no assignments of this type present - } - - $componentstr = get_string('modulenameplural', 'assignment'); - $status = array(); - - $typestr = get_string('type'.$this->type, 'assignment'); - - if (!empty($data->reset_assignment_submissions)) { - $assignmentssql = "SELECT a.id - FROM {$CFG->prefix}assignment a - WHERE a.course={$data->courseid} AND a.assignmenttype='{$this->type}'"; - - delete_records_select('assignment_submissions', "assignment IN ($assignmentssql)"); - - if ($assignments = get_records_sql($assignmentssql)) { - foreach ($assignments as $assignmentid=>$unused) { - fulldelete($CFG->dataroot.'/'.$data->courseid.'/moddata/assignment/'.$assignmentid); - } - } - - $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallsubmissions','assignment').': '.$typestr, 'error'=>false); - - if (empty($data->reset_gradebook_grades)) { - // remove all grades from gradebook - assignment_reset_gradebook($data->courseid, $this->type); - } - } - - /// updating dates - shift may be negative too - if ($data->timeshift) { - shift_course_mod_dates('assignment', array('timedue', 'timeavailable'), $data->timeshift, $data->courseid); - $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged').': '.$typestr, 'error'=>false); - } - - return $status; - } -} ////// End of the assignment_base class - - - -/// OTHER STANDARD FUNCTIONS //////////////////////////////////////////////////////// - -/** - * Deletes an assignment instance - * - * This is done by calling the delete_instance() method of the assignment type class - */ -function assignment_delete_instance($id){ - global $CFG; - - if (! $assignment = get_record('assignment', 'id', $id)) { - return false; - } - - // fall back to base class if plugin missing - $classfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php"; - if (file_exists($classfile)) { - require_once($classfile); - $assignmentclass = "assignment_$assignment->assignmenttype"; - - } else { - debugging("Missing assignment plug-in: {$assignment->assignmenttype}. Using base class for deleting instead."); - $assignmentclass = "assignment_base"; - } - - $ass = new $assignmentclass(); - return $ass->delete_instance($assignment); -} - - -/** - * Updates an assignment instance - * - * This is done by calling the update_instance() method of the assignment type class - */ -function assignment_update_instance($assignment){ - global $CFG; - - $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_SAFEDIR); - - require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php"); - $assignmentclass = "assignment_$assignment->assignmenttype"; - $ass = new $assignmentclass(); - return $ass->update_instance($assignment); -} - - -/** - * Adds an assignment instance - * - * This is done by calling the add_instance() method of the assignment type class - */ -function assignment_add_instance($assignment) { - global $CFG; - - $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_SAFEDIR); - - require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php"); - $assignmentclass = "assignment_$assignment->assignmenttype"; - $ass = new $assignmentclass(); - return $ass->add_instance($assignment); -} - - -/** - * Returns an outline of a user interaction with an assignment - * - * This is done by calling the user_outline() method of the assignment type class - */ -function assignment_user_outline($course, $user, $mod, $assignment) { - global $CFG; - - require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php"); - $assignmentclass = "assignment_$assignment->assignmenttype"; - $ass = new $assignmentclass($mod->id, $assignment, $mod, $course); - return $ass->user_outline($user); -} - -/** - * Prints the complete info about a user's interaction with an assignment - * - * This is done by calling the user_complete() method of the assignment type class - */ -function assignment_user_complete($course, $user, $mod, $assignment) { - global $CFG; - - require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php"); - $assignmentclass = "assignment_$assignment->assignmenttype"; - $ass = new $assignmentclass($mod->id, $assignment, $mod, $course); - return $ass->user_complete($user); -} - -/** - * Function to be run periodically according to the moodle cron - * - * Finds all assignment notifications that have yet to be mailed out, and mails them - */ -function assignment_cron () { - - global $CFG, $USER; - - /// first execute all crons in plugins - if ($plugins = get_list_of_plugins('mod/assignment/type')) { - foreach ($plugins as $plugin) { - require_once("$CFG->dirroot/mod/assignment/type/$plugin/assignment.class.php"); - $assignmentclass = "assignment_$plugin"; - $ass = new $assignmentclass(); - $ass->cron(); - } - } - - /// Notices older than 1 day will not be mailed. This is to avoid the problem where - /// cron has not been running for a long time, and then suddenly people are flooded - /// with mail from the past few weeks or months - - $timenow = time(); - $endtime = $timenow - $CFG->maxeditingtime; - $starttime = $endtime - 24 * 3600; /// One day earlier - - if ($submissions = assignment_get_unmailed_submissions($starttime, $endtime)) { - - $realuser = clone($USER); - - foreach ($submissions as $key => $submission) { - if (! set_field("assignment_submissions", "mailed", "1", "id", "$submission->id")) { - echo "Could not update the mailed field for id $submission->id. Not mailed.\n"; - unset($submissions[$key]); - } - } - - $timenow = time(); - - foreach ($submissions as $submission) { - - echo "Processing assignment submission $submission->id\n"; - - if (! $user = get_record("user", "id", "$submission->userid")) { - echo "Could not find user $post->userid\n"; - continue; - } - - if (! $course = get_record("course", "id", "$submission->course")) { - echo "Could not find course $submission->course\n"; - continue; - } - - /// Override the language and timezone of the "current" user, so that - /// mail is customised for the receiver. - $USER = $user; - course_setup($course); - - if (!has_capability('moodle/course:view', get_context_instance(CONTEXT_COURSE, $submission->course), $user->id)) { - echo fullname($user)." not an active participant in " . format_string($course->shortname) . "\n"; - continue; - } - - if (! $teacher = get_record("user", "id", "$submission->teacher")) { - echo "Could not find teacher $submission->teacher\n"; - continue; - } - - if (! $mod = get_coursemodule_from_instance("assignment", $submission->assignment, $course->id)) { - echo "Could not find course module for assignment id $submission->assignment\n"; - continue; - } - - if (! $mod->visible) { /// Hold mail notification for hidden assignments until later - continue; - } - - $strassignments = get_string("modulenameplural", "assignment"); - $strassignment = get_string("modulename", "assignment"); - - $assignmentinfo = new object(); - $assignmentinfo->teacher = fullname($teacher); - $assignmentinfo->assignment = format_string($submission->name,true); - $assignmentinfo->url = "$CFG->wwwroot/mod/assignment/view.php?id=$mod->id"; - - $postsubject = "$course->shortname: $strassignments: ".format_string($submission->name,true); - $posttext = "$course->shortname -> $strassignments -> ".format_string($submission->name,true)."\n"; - $posttext .= "---------------------------------------------------------------------\n"; - $posttext .= get_string("assignmentmail", "assignment", $assignmentinfo)."\n"; - $posttext .= "---------------------------------------------------------------------\n"; - - if ($user->mailformat == 1) { // HTML - $posthtml = "

". - "wwwroot/course/view.php?id=$course->id\">$course->shortname ->". - "wwwroot/mod/assignment/index.php?id=$course->id\">$strassignments ->". - "wwwroot/mod/assignment/view.php?id=$mod->id\">".format_string($submission->name,true)."

"; - $posthtml .= "
"; - $posthtml .= "

".get_string("assignmentmailhtml", "assignment", $assignmentinfo)."

"; - $posthtml .= "
"; - } else { - $posthtml = ""; - } - - if (! email_to_user($user, $teacher, $postsubject, $posttext, $posthtml)) { - echo "Error: assignment cron: Could not send out mail for id $submission->id to user $user->id ($user->email)\n"; - } - } - - $USER = $realuser; - course_setup(SITEID); // reset cron user language, theme and timezone settings - - } - - return true; -} - -/** - * Return grade for given user or all users. - * - * @param int $assignmentid id of assignment - * @param int $userid optional user id, 0 means all users - * @return array array of grades, false if none - */ -function assignment_get_user_grades($assignment, $userid=0) { - global $CFG; - - $user = $userid ? "AND u.id = $userid" : ""; - - $sql = "SELECT u.id, u.id AS userid, s.grade AS rawgrade, s.submissioncomment AS feedback, s.format AS feedbackformat, - s.teacher AS usermodified, s.timemarked AS dategraded, s.timemodified AS datesubmitted - FROM {$CFG->prefix}user u, {$CFG->prefix}assignment_submissions s - WHERE u.id = s.userid AND s.assignment = $assignment->id - $user"; - - return get_records_sql($sql); -} - -/** - * Update grades by firing grade_updated event - * - * @param object $assignment null means all assignments - * @param int $userid specific user only, 0 mean all - */ -function assignment_update_grades($assignment=null, $userid=0, $nullifnone=true) { - global $CFG; - if (!function_exists('grade_update')) { //workaround for buggy PHP versions - require_once($CFG->libdir.'/gradelib.php'); - } - - if ($assignment != null) { - if ($grades = assignment_get_user_grades($assignment, $userid)) { - foreach($grades as $k=>$v) { - if ($v->rawgrade == -1) { - $grades[$k]->rawgrade = null; - } - } - assignment_grade_item_update($assignment, $grades); - } else { - assignment_grade_item_update($assignment); - } - - } else { - $sql = "SELECT a.*, cm.idnumber as cmidnumber, a.course as courseid - FROM {$CFG->prefix}assignment a, {$CFG->prefix}course_modules cm, {$CFG->prefix}modules m - WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id"; - if ($rs = get_recordset_sql($sql)) { - while ($assignment = rs_fetch_next_record($rs)) { - if ($assignment->grade != 0) { - assignment_update_grades($assignment); - } else { - assignment_grade_item_update($assignment); - } - } - rs_close($rs); - } - } -} - -/** - * Create grade item for given assignment - * - * @param object $assignment object with extra cmidnumber - * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook - * @return int 0 if ok, error code otherwise - */ -function assignment_grade_item_update($assignment, $grades=NULL) { - global $CFG; - if (!function_exists('grade_update')) { //workaround for buggy PHP versions - require_once($CFG->libdir.'/gradelib.php'); - } - - if (!isset($assignment->courseid)) { - $assignment->courseid = $assignment->course; - } - - $params = array('itemname'=>$assignment->name, 'idnumber'=>$assignment->cmidnumber); - - if ($assignment->grade > 0) { - $params['gradetype'] = GRADE_TYPE_VALUE; - $params['grademax'] = $assignment->grade; - $params['grademin'] = 0; - - } else if ($assignment->grade < 0) { - $params['gradetype'] = GRADE_TYPE_SCALE; - $params['scaleid'] = -$assignment->grade; - - } else { - $params['gradetype'] = GRADE_TYPE_TEXT; // allow text comments only - } - - if ($grades === 'reset') { - $params['reset'] = true; - $grades = NULL; - } - - return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, $grades, $params); -} - -/** - * Delete grade item for given assignment - * - * @param object $assignment object - * @return object assignment - */ -function assignment_grade_item_delete($assignment) { - global $CFG; - require_once($CFG->libdir.'/gradelib.php'); - - if (!isset($assignment->courseid)) { - $assignment->courseid = $assignment->course; - } - - return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, NULL, array('deleted'=>1)); -} - -/** - * Returns the users with data in one assignment (students and teachers) - * - * @param $assignmentid int - * @return array of user objects - */ -function assignment_get_participants($assignmentid) { - - global $CFG; - - //Get students - $students = get_records_sql("SELECT DISTINCT u.id, u.id - FROM {$CFG->prefix}user u, - {$CFG->prefix}assignment_submissions a - WHERE a.assignment = '$assignmentid' and - u.id = a.userid"); - //Get teachers - $teachers = get_records_sql("SELECT DISTINCT u.id, u.id - FROM {$CFG->prefix}user u, - {$CFG->prefix}assignment_submissions a - WHERE a.assignment = '$assignmentid' and - u.id = a.teacher"); - - //Add teachers to students - if ($teachers) { - foreach ($teachers as $teacher) { - $students[$teacher->id] = $teacher; - } - } - //Return students array (it contains an array of unique users) - return ($students); -} - -/** - * Checks if a scale is being used by an assignment - * - * This is used by the backup code to decide whether to back up a scale - * @param $assignmentid int - * @param $scaleid int - * @return boolean True if the scale is used by the assignment - */ -function assignment_scale_used($assignmentid, $scaleid) { - - $return = false; - - $rec = get_record('assignment','id',$assignmentid,'grade',-$scaleid); - - if (!empty($rec) && !empty($scaleid)) { - $return = true; - } - - return $return; -} - -/** - * Checks if scale is being used by any instance of assignment - * - * This is used to find out if scale used anywhere - * @param $scaleid int - * @return boolean True if the scale is used by any assignment - */ -function assignment_scale_used_anywhere($scaleid) { - if ($scaleid and record_exists('assignment', 'grade', -$scaleid)) { - return true; - } else { - return false; - } -} - -/** - * Make sure up-to-date events are created for all assignment instances - * - * This standard function will check all instances of this module - * and make sure there are up-to-date events created for each of them. - * If courseid = 0, then every assignment event in the site is checked, else - * only assignment events belonging to the course specified are checked. - * This function is used, in its new format, by restore_refresh_events() - * - * @param $courseid int optional If zero then all assignments for all courses are covered - * @return boolean Always returns true - */ -function assignment_refresh_events($courseid = 0) { - - if ($courseid == 0) { - if (! $assignments = get_records("assignment")) { - return true; - } - } else { - if (! $assignments = get_records("assignment", "course", $courseid)) { - return true; - } - } - $moduleid = get_field('modules', 'id', 'name', 'assignment'); - - foreach ($assignments as $assignment) { - $event = NULL; - $event->name = addslashes($assignment->name); - $event->description = addslashes($assignment->description); - $event->timestart = $assignment->timedue; - - if ($event->id = get_field('event', 'id', 'modulename', 'assignment', 'instance', $assignment->id)) { - update_event($event); - - } else { - $event->courseid = $assignment->course; - $event->groupid = 0; - $event->userid = 0; - $event->modulename = 'assignment'; - $event->instance = $assignment->id; - $event->eventtype = 'due'; - $event->timeduration = 0; - $event->visible = get_field('course_modules', 'visible', 'module', $moduleid, 'instance', $assignment->id); - add_event($event); - } - - } - return true; -} - -/** - * Print recent activity from all assignments in a given course - * - * This is used by the recent activity block - */ -function assignment_print_recent_activity($course, $viewfullnames, $timestart) { - global $CFG, $USER; - - // do not use log table if possible, it may be huge - - if (!$submissions = get_records_sql("SELECT asb.id, asb.timemodified, cm.id AS cmid, asb.userid, - u.firstname, u.lastname, u.email, u.picture - FROM {$CFG->prefix}assignment_submissions asb - JOIN {$CFG->prefix}assignment a ON a.id = asb.assignment - JOIN {$CFG->prefix}course_modules cm ON cm.instance = a.id - JOIN {$CFG->prefix}modules md ON md.id = cm.module - JOIN {$CFG->prefix}user u ON u.id = asb.userid - WHERE asb.timemodified > $timestart AND - a.course = {$course->id} AND - md.name = 'assignment' - ORDER BY asb.timemodified ASC")) { - return false; - } - - $modinfo =& get_fast_modinfo($course); // reference needed because we might load the groups - $show = array(); - $grader = array(); - - foreach($submissions as $submission) { - if (!array_key_exists($submission->cmid, $modinfo->cms)) { - continue; - } - $cm = $modinfo->cms[$submission->cmid]; - if (!$cm->uservisible) { - continue; - } - if ($submission->userid == $USER->id) { - $show[] = $submission; - continue; - } - - // the act of sumbitting of assignment may be considered private - only graders will see it if specified - if (empty($CFG->assignment_showrecentsubmissions)) { - if (!array_key_exists($cm->id, $grader)) { - $grader[$cm->id] = has_capability('moodle/grade:viewall', get_context_instance(CONTEXT_MODULE, $cm->id)); - } - if (!$grader[$cm->id]) { - continue; - } - } - - $groupmode = groups_get_activity_groupmode($cm, $course); - - if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) { - if (isguestuser()) { - // shortcut - guest user does not belong into any group - continue; - } - - if (is_null($modinfo->groups)) { - $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo - } - - // this will be slow - show only users that share group with me in this cm - if (empty($modinfo->groups[$cm->id])) { - continue; - } - $usersgroups = groups_get_all_groups($course->id, $cm->userid, $cm->groupingid); - if (is_array($usersgroups)) { - $usersgroups = array_keys($usersgroups); - $interset = array_intersect($usersgroups, $modinfo->groups[$cm->id]); - if (empty($intersect)) { - continue; - } - } - } - $show[] = $submission; - } - - if (empty($show)) { - return false; - } - - print_headline(get_string('newsubmissions', 'assignment').':'); - - foreach ($show as $submission) { - $cm = $modinfo->cms[$submission->cmid]; - $link = $CFG->wwwroot.'/mod/assignment/view.php?id='.$cm->id; - print_recent_activity_note($submission->timemodified, $submission, $cm->name, $link, false, $viewfullnames); - } - - return true; -} - - -/** - * Returns all assignments since a given time in specified forum. - */ -function assignment_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0) { - - global $CFG, $COURSE, $USER; - - if ($COURSE->id == $courseid) { - $course = $COURSE; - } else { - $course = get_record('course', 'id', $courseid); - } - - $modinfo =& get_fast_modinfo($course); - - $cm = $modinfo->cms[$cmid]; - - if ($userid) { - $userselect = "AND u.id = $userid"; - } else { - $userselect = ""; - } - - if ($groupid) { - $groupselect = "AND gm.groupid = $groupid"; - $groupjoin = "JOIN {$CFG->prefix}groups_members gm ON gm.userid=u.id"; - } else { - $groupselect = ""; - $groupjoin = ""; - } - - if (!$submissions = get_records_sql("SELECT asb.id, asb.timemodified, asb.userid, - u.firstname, u.lastname, u.email, u.picture - FROM {$CFG->prefix}assignment_submissions asb - JOIN {$CFG->prefix}assignment a ON a.id = asb.assignment - JOIN {$CFG->prefix}user u ON u.id = asb.userid - $groupjoin - WHERE asb.timemodified > $timestart AND a.id = $cm->instance - $userselect $groupselect - ORDER BY asb.timemodified ASC")) { - return; - } - - $groupmode = groups_get_activity_groupmode($cm, $course); - $cm_context = get_context_instance(CONTEXT_MODULE, $cm->id); - $grader = has_capability('moodle/grade:viewall', $cm_context); - $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context); - $viewfullnames = has_capability('moodle/site:viewfullnames', $cm_context); - - if (is_null($modinfo->groups)) { - $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo - } - - $show = array(); - - foreach($submissions as $submission) { - if ($submission->userid == $USER->id) { - $show[] = $submission; - continue; - } - // the act of submitting of assignment may be considered private - only graders will see it if specified - if (empty($CFG->assignment_showrecentsubmissions)) { - if (!$grader) { - continue; - } - } - - if ($groupmode == SEPARATEGROUPS and !$accessallgroups) { - if (isguestuser()) { - // shortcut - guest user does not belong into any group - continue; - } - - // this will be slow - show only users that share group with me in this cm - if (empty($modinfo->groups[$cm->id])) { - continue; - } - $usersgroups = groups_get_all_groups($course->id, $cm->userid, $cm->groupingid); - if (is_array($usersgroups)) { - $usersgroups = array_keys($usersgroups); - $interset = array_intersect($usersgroups, $modinfo->groups[$cm->id]); - if (empty($intersect)) { - continue; - } - } - } - $show[] = $submission; - } - - if (empty($show)) { - return; - } - - if ($grader) { - require_once($CFG->libdir.'/gradelib.php'); - $userids = array(); - foreach ($show as $id=>$submission) { - $userids[] = $submission->userid; - - } - $grades = grade_get_grades($courseid, 'mod', 'assignment', $cm->instance, $userids); - } - - $aname = format_string($cm->name,true); - foreach ($show as $submission) { - $tmpactivity = new object(); - - $tmpactivity->type = 'assignment'; - $tmpactivity->cmid = $cm->id; - $tmpactivity->name = $aname; - $tmpactivity->sectionnum = $cm->sectionnum; - $tmpactivity->timestamp = $submission->timemodified; - - if ($grader) { - $tmpactivity->grade = $grades->items[0]->grades[$submission->userid]->str_long_grade; - } - - $tmpactivity->user->userid = $submission->userid; - $tmpactivity->user->fullname = fullname($submission, $viewfullnames); - $tmpactivity->user->picture = $submission->picture; - - $activities[$index++] = $tmpactivity; - } - - return; -} - -/** - * Print recent activity from all assignments in a given course - * - * This is used by course/recent.php - */ -function assignment_print_recent_mod_activity($activity, $courseid, $detail, $modnames) { - global $CFG; - - echo ''; - - echo "
"; - print_user_picture($activity->user->userid, $courseid, $activity->user->picture); - echo ""; - - if ($detail) { - $modname = $modnames[$activity->type]; - echo '
'; - echo "modpixpath/assignment/icon.gif\" ". - "class=\"icon\" alt=\"$modname\">"; - echo "wwwroot/mod/assignment/view.php?id={$activity->cmid}\">{$activity->name}"; - echo '
'; - } - - if (isset($activity->grade)) { - echo '
'; - echo get_string('grade').': '; - echo $activity->grade; - echo '
'; - } - - echo '
'; - echo "wwwroot/user/view.php?id={$activity->user->userid}&course=$courseid\">" - ."{$activity->user->fullname} - ".userdate($activity->timestamp); - echo '
'; - - echo "
"; -} - -/// GENERIC SQL FUNCTIONS - -/** - * Fetch info from logs - * - * @param $log object with properties ->info (the assignment id) and ->userid - * @return array with assignment name and user firstname and lastname - */ -function assignment_log_info($log) { - global $CFG; - return get_record_sql("SELECT a.name, u.firstname, u.lastname - FROM {$CFG->prefix}assignment a, - {$CFG->prefix}user u - WHERE a.id = '$log->info' - AND u.id = '$log->userid'"); -} - -/** - * Return list of marked submissions that have not been mailed out for currently enrolled students - * - * @return array - */ -function assignment_get_unmailed_submissions($starttime, $endtime) { - - global $CFG; - - return get_records_sql("SELECT s.*, a.course, a.name - FROM {$CFG->prefix}assignment_submissions s, - {$CFG->prefix}assignment a - WHERE s.mailed = 0 - AND s.timemarked <= $endtime - AND s.timemarked >= $starttime - AND s.assignment = a.id"); - - /* return get_records_sql("SELECT s.*, a.course, a.name - FROM {$CFG->prefix}assignment_submissions s, - {$CFG->prefix}assignment a, - {$CFG->prefix}user_students us - WHERE s.mailed = 0 - AND s.timemarked <= $endtime - AND s.timemarked >= $starttime - AND s.assignment = a.id - AND s.userid = us.userid - AND a.course = us.course"); - */ -} - -/** - * Counts all real assignment submissions by ENROLLED students (not empty ones) - * - * There are also assignment type methods count_real_submissions() wich in the default - * implementation simply call this function. - * @param $groupid int optional If nonzero then count is restricted to this group - * @return int The number of submissions - */ -function assignment_count_real_submissions($cm, $groupid=0) { - global $CFG; - - $context = get_context_instance(CONTEXT_MODULE, $cm->id); - - // this is all the users with this capability set, in this context or higher - if ($users = get_users_by_capability($context, 'mod/assignment:submit', 'u.id', '', '', '', $groupid, '', false)) { - $users = array_keys($users); - } - - // if groupmembersonly used, remove users who are not in any group - if ($users and !empty($CFG->enablegroupings) and $cm->groupmembersonly) { - if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) { - $users = array_intersect($users, array_keys($groupingusers)); - } - } - - if (empty($users)) { - return 0; - } - - $userlists = implode(',', $users); - - return count_records_sql("SELECT COUNT('x') - FROM {$CFG->prefix}assignment_submissions - WHERE assignment = $cm->instance AND - timemodified > 0 AND - userid IN ($userlists)"); -} - - -/** - * Return all assignment submissions by ENROLLED students (even empty) - * - * There are also assignment type methods get_submissions() wich in the default - * implementation simply call this function. - * @param $sort string optional field names for the ORDER BY in the sql query - * @param $dir string optional specifying the sort direction, defaults to DESC - * @return array The submission objects indexed by id - */ -function assignment_get_all_submissions($assignment, $sort="", $dir="DESC") { -/// Return all assignment submissions by ENROLLED students (even empty) - global $CFG; - - if ($sort == "lastname" or $sort == "firstname") { - $sort = "u.$sort $dir"; - } else if (empty($sort)) { - $sort = "a.timemodified DESC"; - } else { - $sort = "a.$sort $dir"; - } - - /* not sure this is needed at all since assignmenet already has a course define, so this join? - $select = "s.course = '$assignment->course' AND"; - if ($assignment->course == SITEID) { - $select = ''; - }*/ - - return get_records_sql("SELECT a.* - FROM {$CFG->prefix}assignment_submissions a, - {$CFG->prefix}user u - WHERE u.id = a.userid - AND a.assignment = '$assignment->id' - ORDER BY $sort"); - - /* return get_records_sql("SELECT a.* - FROM {$CFG->prefix}assignment_submissions a, - {$CFG->prefix}user_students s, - {$CFG->prefix}user u - WHERE a.userid = s.userid - AND u.id = a.userid - AND $select a.assignment = '$assignment->id' - ORDER BY $sort"); - */ -} - -/** - * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information - * for the course (see resource). - * - * Given a course_module object, this function returns any "extra" information that may be needed - * when printing this activity in a course listing. See get_array_of_activities() in course/lib.php. - * - * @param $coursemodule object The coursemodule object (record). - * @return object An object on information that the coures will know about (most noticeably, an icon). - * - */ -function assignment_get_coursemodule_info($coursemodule) { - global $CFG; - - if (! $assignment = get_record('assignment', 'id', $coursemodule->instance, '', '', '', '', 'id, assignmenttype, name')) { - return false; - } - - $libfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php"; - - if (file_exists($libfile)) { - require_once($libfile); - $assignmentclass = "assignment_$assignment->assignmenttype"; - $ass = new $assignmentclass('staticonly'); - if ($result = $ass->get_coursemodule_info($coursemodule)) { - return $result; - } else { - $info = new object(); - $info->name = $assignment->name; - return $info; - } - - } else { - debugging('Incorrect assignment type: '.$assignment->assignmenttype); - return false; - } -} - - - -/// OTHER GENERAL FUNCTIONS FOR ASSIGNMENTS /////////////////////////////////////// - -/** - * Returns an array of installed assignment types indexed and sorted by name - * - * @return array The index is the name of the assignment type, the value its full name from the language strings - */ -function assignment_types() { - $types = array(); - $names = get_list_of_plugins('mod/assignment/type'); - foreach ($names as $name) { - $types[$name] = get_string('type'.$name, 'assignment'); - } - asort($types); - return $types; -} - -/** - * Executes upgrade scripts for assignment types when necessary - */ -function assignment_upgrade_submodules() { - - global $CFG; - -/// Install/upgrade assignment types (it uses, simply, the standard plugin architecture) - upgrade_plugins('assignment_type', 'mod/assignment/type', "$CFG->wwwroot/$CFG->admin/index.php"); - -} - -function assignment_print_overview($courses, &$htmlarray) { - - global $USER, $CFG; - - if (empty($courses) || !is_array($courses) || count($courses) == 0) { - return array(); - } - - if (!$assignments = get_all_instances_in_courses('assignment',$courses)) { - return; - } - - $assignmentids = array(); - - // Do assignment_base::isopen() here without loading the whole thing for speed - foreach ($assignments as $key => $assignment) { - $time = time(); - if ($assignment->timedue) { - if ($assignment->preventlate) { - $isopen = ($assignment->timeavailable <= $time && $time <= $assignment->timedue); - } else { - $isopen = ($assignment->timeavailable <= $time); - } - } - if (empty($isopen) || empty($assignment->timedue)) { - unset($assignments[$key]); - }else{ - $assignmentids[] = $assignment->id; - } - } - - if(empty($assignmentids)){ - // no assigments to look at - we're done - return true; - } - - $strduedate = get_string('duedate', 'assignment'); - $strduedateno = get_string('duedateno', 'assignment'); - $strgraded = get_string('graded', 'assignment'); - $strnotgradedyet = get_string('notgradedyet', 'assignment'); - $strnotsubmittedyet = get_string('notsubmittedyet', 'assignment'); - $strsubmitted = get_string('submitted', 'assignment'); - $strassignment = get_string('modulename', 'assignment'); - $strreviewed = get_string('reviewed','assignment'); - - - // NOTE: we do all possible database work here *outside* of the loop to ensure this scales - - // build up and array of unmarked submissions indexed by assigment id/ userid - // for use where the user has grading rights on assigment - $rs = get_recordset_sql("SELECT id, assignment, userid - FROM {$CFG->prefix}assignment_submissions - WHERE teacher = 0 AND timemarked = 0 - AND assignment IN (". implode(',', $assignmentids).")"); - - $unmarkedsubmissions = array(); - while ($ra = rs_fetch_next_record($rs)) { - $unmarkedsubmissions[$ra->assignment][$ra->userid] = $ra->id; - } - rs_close($rs); - - - // get all user submissions, indexed by assigment id - $mysubmissions = get_records_sql("SELECT assignment, timemarked, teacher, grade - FROM {$CFG->prefix}assignment_submissions - WHERE userid = {$USER->id} AND - assignment IN (".implode(',', $assignmentids).")"); - - foreach ($assignments as $assignment) { - $str = '
'.$strassignment. ': '. - 'visible ? '':' class="dimmed"'). - 'title="'.$strassignment.'" href="'.$CFG->wwwroot. - '/mod/assignment/view.php?id='.$assignment->coursemodule.'">'. - $assignment->name.'
'; - if ($assignment->timedue) { - $str .= '
'.$strduedate.': '.userdate($assignment->timedue).'
'; - } else { - $str .= '
'.$strduedateno.'
'; - } - $context = get_context_instance(CONTEXT_MODULE, $assignment->coursemodule); - if (has_capability('mod/assignment:grade', $context)) { - - // count how many people can submit - $submissions = 0; // init - if ($students = get_users_by_capability($context, 'mod/assignment:submit', 'u.id', '', '', '', 0, '', false)) { - foreach($students as $student){ - if(isset($unmarkedsubmissions[$assignment->id][$student->id])){ - $submissions++; - } - } - } - - if ($submissions) { - $str .= get_string('submissionsnotgraded', 'assignment', $submissions); - } - } else { - if(isset($mysubmissions[$assignment->id])){ - - $submission = $mysubmissions[$assignment->id]; - - if ($submission->teacher == 0 && $submission->timemarked == 0) { - $str .= $strsubmitted . ', ' . $strnotgradedyet; - } else if ($submission->grade <= 0) { - $str .= $strsubmitted . ', ' . $strreviewed; - } else { - $str .= $strsubmitted . ', ' . $strgraded; - } - } else { - $str .= $strnotsubmittedyet . ' ' . assignment_display_lateness(time(), $assignment->timedue); - } - } - $str .= '
'; - if (empty($htmlarray[$assignment->course]['assignment'])) { - $htmlarray[$assignment->course]['assignment'] = $str; - } else { - $htmlarray[$assignment->course]['assignment'] .= $str; - } - } -} - -function assignment_display_lateness($timesubmitted, $timedue) { - if (!$timedue) { - return ''; - } - $time = $timedue - $timesubmitted; - if ($time < 0) { - $timetext = get_string('late', 'assignment', format_time($time)); - return ' ('.$timetext.')'; - } else { - $timetext = get_string('early', 'assignment', format_time($time)); - return ' ('.$timetext.')'; - } -} - -function assignment_get_view_actions() { - return array('view'); -} - -function assignment_get_post_actions() { - return array('upload'); -} - -function assignment_get_types() { - global $CFG; - $types = array(); - - $type = new object(); - $type->modclass = MOD_CLASS_ACTIVITY; - $type->type = "assignment_group_start"; - $type->typestr = '--'.get_string('modulenameplural', 'assignment'); - $types[] = $type; - - $standardassignments = array('upload','online','uploadsingle','offline'); - foreach ($standardassignments as $assignmenttype) { - $type = new object(); - $type->modclass = MOD_CLASS_ACTIVITY; - $type->type = "assignment&type=$assignmenttype"; - $type->typestr = get_string("type$assignmenttype", 'assignment'); - $types[] = $type; - } - - /// Drop-in extra assignment types - $assignmenttypes = get_list_of_plugins('mod/assignment/type'); - foreach ($assignmenttypes as $assignmenttype) { - if (!empty($CFG->{'assignment_hide_'.$assignmenttype})) { // Not wanted - continue; - } - if (!in_array($assignmenttype, $standardassignments)) { - $type = new object(); - $type->modclass = MOD_CLASS_ACTIVITY; - $type->type = "assignment&type=$assignmenttype"; - $type->typestr = get_string("type$assignmenttype", 'assignment'); - $types[] = $type; - } - } - - $type = new object(); - $type->modclass = MOD_CLASS_ACTIVITY; - $type->type = "assignment_group_end"; - $type->typestr = '--'; - $types[] = $type; - - return $types; -} - -/** - * Removes all grades from gradebook - * @param int $courseid - * @param string optional type - */ -function assignment_reset_gradebook($courseid, $type='') { - global $CFG; - - $type = $type ? "AND a.assignmenttype='$type'" : ''; - - $sql = "SELECT a.*, cm.idnumber as cmidnumber, a.course as courseid - FROM {$CFG->prefix}assignment a, {$CFG->prefix}course_modules cm, {$CFG->prefix}modules m - WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id AND a.course=$courseid $type"; - - if ($assignments = get_records_sql($sql)) { - foreach ($assignments as $assignment) { - assignment_grade_item_update($assignment, 'reset'); - } - } -} - -/** - * This function is used by the reset_course_userdata function in moodlelib. - * This function will remove all posts from the specified assignment - * and clean up any related data. - * @param $data the data submitted from the reset course. - * @return array status array - */ -function assignment_reset_userdata($data) { - global $CFG; - - $status = array(); - - foreach (get_list_of_plugins('mod/assignment/type') as $type) { - require_once("$CFG->dirroot/mod/assignment/type/$type/assignment.class.php"); - $assignmentclass = "assignment_$type"; - $ass = new $assignmentclass(); - $status = array_merge($status, $ass->reset_userdata($data)); - } - - return $status; -} - -/** - * Implementation of the function for printing the form elements that control - * whether the course reset functionality affects the assignment. - * @param $mform form passed by reference - */ -function assignment_reset_course_form_definition(&$mform) { - $mform->addElement('header', 'assignmentheader', get_string('modulenameplural', 'assignment')); - $mform->addElement('advcheckbox', 'reset_assignment_submissions', get_string('deleteallsubmissions','assignment')); -} - -/** - * Course reset form defaults. - */ -function assignment_reset_course_form_defaults($course) { - return array('reset_assignment_submissions'=>1); -} - -/** - * Returns all other caps used in module - */ -function assignment_get_extra_capabilities() { - return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames'); -} - -?> diff --git a/Moodle/mod/print/log.txt b/Moodle/mod/print/log.txt deleted file mode 100755 index 85c4b69..0000000 --- a/Moodle/mod/print/log.txt +++ /dev/null @@ -1,47 +0,0 @@ -Jul 14 05:29:13 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/7: successfull-ok -Jul 14 05:38:00 submissions.php Host localhost:631 user iwikiwi@localhost : printing job http://localhost.localdomain:631/jobs/8: successfull-ok -Jul 14 05:40:18 submissions.php Host localhost:631 user iwikiwi@localhost : printing job http://localhost.localdomain:631/jobs/9: successfull-ok -Jul 14 06:20:21 submissions.php Host localhost:631 user iwikiwi@localhost : printing job http://localhost.localdomain:631/jobs/10: successfull-ok -Jul 14 06:22:54 submissions.php Host localhost:631 user iwikiwi@localhost : printing job http://localhost.localdomain:631/jobs/11: successfull-ok -Jul 14 06:23:51 submissions.php Host localhost:631 user iwikiwi@localhost : printing job http://localhost.localdomain:631/jobs/12: successfull-ok -Jul 14 06:23:56 submissions.php Host localhost:631 user iwikiwi@localhost : printing job http://localhost.localdomain:631/jobs/13: successfull-ok -Jul 14 06:45:47 submissions.php Host localhost:631 user iwikiwi@localhost : printing job http://localhost.localdomain:631/jobs/14: successfull-ok -Jul 14 06:48:14 submissions.php Host localhost:631 user iwikiwi@localhost : printing job http://localhost.localdomain:631/jobs/15: successfull-ok -Jul 14 06:59:20 submissions.php Host localhost:631 user iwikiwi@localhost : printing job http://localhost.localdomain:631/jobs/16: successfull-ok -Jul 14 07:01:33 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/17: successfull-ok -Jul 14 07:03:13 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/18: successfull-ok -Jul 14 07:03:43 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/19: successfull-ok -Jul 14 07:07:53 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/20: successfull-ok -Jul 14 07:17:46 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/21: successfull-ok -Jul 14 07:27:07 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/22: successfull-ok -Jul 14 12:56:36 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/23: successfull-ok -Jul 14 12:59:01 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/24: successfull-ok -Jul 14 14:36:15 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/25: successfull-ok -Jul 14 14:36:20 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/26: successfull-ok -Jul 14 14:59:51 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/27: successfull-ok -Jul 14 15:02:17 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/28: successfull-ok -Jul 14 15:02:50 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/29: successfull-ok -Jul 14 15:03:14 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/30: successfull-ok -Jul 14 15:03:38 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/31: successfull-ok -Jul 14 15:03:41 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/32: successfull-ok -Jul 14 15:03:43 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/33: successfull-ok -Jul 14 15:03:46 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/34: successfull-ok -Jul 14 15:07:10 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/35: successfull-ok -Jul 14 15:07:42 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/36: successfull-ok -Jul 14 15:14:16 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/37: successfull-ok -Jul 14 19:30:03 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/38: successfull-ok -Jul 14 19:51:32 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/39: successfull-ok -Jul 29 21:09:56 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/83: successfull-ok -Jul 30 14:06:29 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/84: successfull-ok -Jul 30 14:23:06 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/85: successfull-ok -Jul 30 14:26:06 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/86: successfull-ok -Jul 31 00:22:54 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/87: successfull-ok -Jul 31 03:46:42 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/88: successfull-ok -Jul 31 03:47:52 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/89: successfull-ok -Jul 31 03:48:15 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/90: successfull-ok -Jul 31 03:55:34 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/91: successfull-ok -Jul 31 04:02:54 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/92: successfull-ok -Jul 31 04:04:01 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/93: successfull-ok -Jul 31 05:24:19 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/94: successfull-ok -Jul 31 05:26:26 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/95: successfull-ok -Jul 31 05:28:31 submissions.php Host localhost:631 user PHP-SERVER : printing job http://localhost.localdomain:631/jobs/96: successfull-ok diff --git a/Moodle/mod/print/print_xmlrpc.php b/Moodle/mod/print/print_xmlrpc.php index 63df086..b74a550 100755 --- a/Moodle/mod/print/print_xmlrpc.php +++ b/Moodle/mod/print/print_xmlrpc.php @@ -21,13 +21,14 @@ function actual_func($file, $title) { global $USER; error_log("okay first step done", 0); #require_login(); - $olpcxs = get_auth_plugin('olpcxs'); - $olpcxs->loginpage_hook(); + #$olpcxs = get_auth_plugin('olpcxs'); + #$olpcxs->loginpage_hook(); error_log("require login done", 0); #$userrecord = get_record('user', 'username', $username); #$userid = $userrecord->id; - $id = 2; + + $id = 1; if ($id) { if (! $cm = get_coursemodule_from_id('print', $id)) { error("Course Module ID was incorrect"); @@ -67,19 +68,62 @@ function actual_func($file, $title) { $assignmentinstance->upload_xmlrpc($fpath, $userid, $title, $assignment);// Display or process the submissions return 1; } -function send_func($method_name, $params, $app_data) { - $file = $params[0]; - $title = $params[1]; - actual_func($file, $title); - return 1; + +function get_course_details($method_name, $params, $app_data) { + require_once("../../config.php"); + require_once("lib.php"); + require_once("../../lib/moodlelib.php"); + require_once('../../lib/datalib.php'); + require_once('xmlrpc.inc'); + require_once('xmlrpcs.inc'); + + global $CFG; + global $USER; + #error_log("okay first step done", 0); + + #require_login(); + #$olpcxs = get_auth_plugin('olpcxs'); + #$olpcxs->loginpage_hook(); + + $usr = 3; + if (isset($usr)) { + #error_log('lol'.var_dump($USER), 0); + $courseArray = get_my_courses(3); + $i = 1; + foreach ( $courseArray as $course) { + $records[$i] = get_record_sql("SELECT * + FROM {$CFG->prefix}print + WHERE course = $course->id"); + $i++; + } + $i = 1; + + foreach( $records as $record) { + + $course = get_record('course','id', $record->course); + $tosend[$i] = array('modulename'=> $record->name, + 'coursename'=> $course->shortname, + 'courseid'=> $record->course); + $i++; + } + #ob_start(); + #print_r($tosend); + #$output = ob_get_contents(); + #error_log($output, 0); + return $tosend; + } + return 1; } -function greeting_func($method_name, $params, $app_data) -{ - $name = $params[0]; - return "Hello, $name. How are you today?"; +function send_func($method_name, $params, $app_data) { + $file = $params[0]; + $title = $params[1]; + actual_func($file, $title); + return 1; } + + /* * This creates a server and sets a handle for the * server in the variable $xmlrpc_server @@ -99,7 +143,7 @@ $xmlrpc_server = xmlrpc_server_create(); */ xmlrpc_server_register_method($xmlrpc_server, "send_func", "send_func"); -xmlrpc_server_register_method($xmlrpc_server, "greeting_func", "greeting_func"); +xmlrpc_server_register_method($xmlrpc_server, "get_course_details", "get_course_details"); /* * When an XML-RPC request is sent to this script, it diff --git a/Moodle/mod/print/xmlrpc.inc b/Moodle/mod/print/xmlrpc.inc new file mode 100644 index 0000000..21e29a0 --- /dev/null +++ b/Moodle/mod/print/xmlrpc.inc @@ -0,0 +1,3718 @@ + +// $Id: xmlrpc.inc,v 1.174 2009/03/16 19:36:38 ggiunta Exp $ + +// Copyright (c) 1999,2000,2002 Edd Dumbill. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions +// are met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following +// disclaimer in the documentation and/or other materials provided +// with the distribution. +// +// * Neither the name of the "XML-RPC for PHP" nor the names of its +// contributors may be used to endorse or promote products derived +// from this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +// REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. + + if(!function_exists('xml_parser_create')) + { + // For PHP 4 onward, XML functionality is always compiled-in on windows: + // no more need to dl-open it. It might have been compiled out on *nix... + if(strtoupper(substr(PHP_OS, 0, 3) != 'WIN')) + { + dl('xml.so'); + } + } + + // Try to be backward compat with php < 4.2 (are we not being nice ?) + $phpversion = phpversion(); + if($phpversion[0] == '4' && $phpversion[2] < 2) + { + // give an opportunity to user to specify where to include other files from + if(!defined('PHP_XMLRPC_COMPAT_DIR')) + { + define('PHP_XMLRPC_COMPAT_DIR',dirname(__FILE__).'/compat/'); + } + if($phpversion[2] == '0') + { + if($phpversion[4] < 6) + { + include(PHP_XMLRPC_COMPAT_DIR.'is_callable.php'); + } + include(PHP_XMLRPC_COMPAT_DIR.'is_scalar.php'); + include(PHP_XMLRPC_COMPAT_DIR.'array_key_exists.php'); + include(PHP_XMLRPC_COMPAT_DIR.'version_compare.php'); + } + include(PHP_XMLRPC_COMPAT_DIR.'var_export.php'); + include(PHP_XMLRPC_COMPAT_DIR.'is_a.php'); + } + + // G. Giunta 2005/01/29: declare global these variables, + // so that xmlrpc.inc will work even if included from within a function + // Milosch: 2005/08/07 - explicitly request these via $GLOBALS where used. + $GLOBALS['xmlrpcI4']='i4'; + $GLOBALS['xmlrpcInt']='int'; + $GLOBALS['xmlrpcBoolean']='boolean'; + $GLOBALS['xmlrpcDouble']='double'; + $GLOBALS['xmlrpcString']='string'; + $GLOBALS['xmlrpcDateTime']='dateTime.iso8601'; + $GLOBALS['xmlrpcBase64']='base64'; + $GLOBALS['xmlrpcArray']='array'; + $GLOBALS['xmlrpcStruct']='struct'; + $GLOBALS['xmlrpcValue']='undefined'; + + $GLOBALS['xmlrpcTypes']=array( + $GLOBALS['xmlrpcI4'] => 1, + $GLOBALS['xmlrpcInt'] => 1, + $GLOBALS['xmlrpcBoolean'] => 1, + $GLOBALS['xmlrpcString'] => 1, + $GLOBALS['xmlrpcDouble'] => 1, + $GLOBALS['xmlrpcDateTime'] => 1, + $GLOBALS['xmlrpcBase64'] => 1, + $GLOBALS['xmlrpcArray'] => 2, + $GLOBALS['xmlrpcStruct'] => 3 + ); + + $GLOBALS['xmlrpc_valid_parents'] = array( + 'VALUE' => array('MEMBER', 'DATA', 'PARAM', 'FAULT'), + 'BOOLEAN' => array('VALUE'), + 'I4' => array('VALUE'), + 'INT' => array('VALUE'), + 'STRING' => array('VALUE'), + 'DOUBLE' => array('VALUE'), + 'DATETIME.ISO8601' => array('VALUE'), + 'BASE64' => array('VALUE'), + 'MEMBER' => array('STRUCT'), + 'NAME' => array('MEMBER'), + 'DATA' => array('ARRAY'), + 'ARRAY' => array('VALUE'), + 'STRUCT' => array('VALUE'), + 'PARAM' => array('PARAMS'), + 'METHODNAME' => array('METHODCALL'), + 'PARAMS' => array('METHODCALL', 'METHODRESPONSE'), + 'FAULT' => array('METHODRESPONSE'), + 'NIL' => array('VALUE') // only used when extension activated + ); + + // define extra types for supporting NULL (useful for json or ) + $GLOBALS['xmlrpcNull']='null'; + $GLOBALS['xmlrpcTypes']['null']=1; + + // Not in use anymore since 2.0. Shall we remove it? + /// @deprecated + $GLOBALS['xmlEntities']=array( + 'amp' => '&', + 'quot' => '"', + 'lt' => '<', + 'gt' => '>', + 'apos' => "'" + ); + + // tables used for transcoding different charsets into us-ascii xml + + $GLOBALS['xml_iso88591_Entities']=array(); + $GLOBALS['xml_iso88591_Entities']['in'] = array(); + $GLOBALS['xml_iso88591_Entities']['out'] = array(); + for ($i = 0; $i < 32; $i++) + { + $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i); + $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';'; + } + for ($i = 160; $i < 256; $i++) + { + $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i); + $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';'; + } + + /// @todo add to iso table the characters from cp_1252 range, i.e. 128 to 159? + /// These will NOT be present in true ISO-8859-1, but will save the unwary + /// windows user from sending junk (though no luck when reciving them...) + /* + $GLOBALS['xml_cp1252_Entities']=array(); + for ($i = 128; $i < 160; $i++) + { + $GLOBALS['xml_cp1252_Entities']['in'][] = chr($i); + } + $GLOBALS['xml_cp1252_Entities']['out'] = array( + '€', '?', '‚', 'ƒ', + '„', '…', '†', '‡', + 'ˆ', '‰', 'Š', '‹', + 'Œ', '?', 'Ž', '?', + '?', '‘', '’', '“', + '”', '•', '–', '—', + '˜', '™', 'š', '›', + 'œ', '?', 'ž', 'Ÿ' + ); + */ + + $GLOBALS['xmlrpcerr'] = array( + 'unknown_method'=>1, + 'invalid_return'=>2, + 'incorrect_params'=>3, + 'introspect_unknown'=>4, + 'http_error'=>5, + 'no_data'=>6, + 'no_ssl'=>7, + 'curl_fail'=>8, + 'invalid_request'=>15, + 'no_curl'=>16, + 'server_error'=>17, + 'multicall_error'=>18, + 'multicall_notstruct'=>9, + 'multicall_nomethod'=>10, + 'multicall_notstring'=>11, + 'multicall_recursion'=>12, + 'multicall_noparams'=>13, + 'multicall_notarray'=>14, + + 'cannot_decompress'=>103, + 'decompress_fail'=>104, + 'dechunk_fail'=>105, + 'server_cannot_decompress'=>106, + 'server_decompress_fail'=>107 + ); + + $GLOBALS['xmlrpcstr'] = array( + 'unknown_method'=>'Unknown method', + 'invalid_return'=>'Invalid return payload: enable debugging to examine incoming payload', + 'incorrect_params'=>'Incorrect parameters passed to method', + 'introspect_unknown'=>"Can't introspect: method unknown", + 'http_error'=>"Didn't receive 200 OK from remote server.", + 'no_data'=>'No data received from server.', + 'no_ssl'=>'No SSL support compiled in.', + 'curl_fail'=>'CURL error', + 'invalid_request'=>'Invalid request payload', + 'no_curl'=>'No CURL support compiled in.', + 'server_error'=>'Internal server error', + 'multicall_error'=>'Received from server invalid multicall response', + 'multicall_notstruct'=>'system.multicall expected struct', + 'multicall_nomethod'=>'missing methodName', + 'multicall_notstring'=>'methodName is not a string', + 'multicall_recursion'=>'recursive system.multicall forbidden', + 'multicall_noparams'=>'missing params', + 'multicall_notarray'=>'params is not an array', + + 'cannot_decompress'=>'Received from server compressed HTTP and cannot decompress', + 'decompress_fail'=>'Received from server invalid compressed HTTP', + 'dechunk_fail'=>'Received from server invalid chunked HTTP', + 'server_cannot_decompress'=>'Received from client compressed HTTP request and cannot decompress', + 'server_decompress_fail'=>'Received from client invalid compressed HTTP request' + ); + + // The charset encoding used by the server for received messages and + // by the client for received responses when received charset cannot be determined + // or is not supported + $GLOBALS['xmlrpc_defencoding']='UTF-8'; + + // The encoding used internally by PHP. + // String values received as xml will be converted to this, and php strings will be converted to xml + // as if having been coded with this + $GLOBALS['xmlrpc_internalencoding']='ISO-8859-1'; + + $GLOBALS['xmlrpcName']='XML-RPC for PHP'; + $GLOBALS['xmlrpcVersion']='2.2.2'; + + // let user errors start at 800 + $GLOBALS['xmlrpcerruser']=800; + // let XML parse errors start at 100 + $GLOBALS['xmlrpcerrxml']=100; + + // formulate backslashes for escaping regexp + // Not in use anymore since 2.0. Shall we remove it? + /// @deprecated + $GLOBALS['xmlrpc_backslash']=chr(92).chr(92); + + // set to TRUE to enable correct decoding of values + $GLOBALS['xmlrpc_null_extension']=false; + + // used to store state during parsing + // quick explanation of components: + // ac - used to accumulate values + // isf - used to indicate a parsing fault (2) or xmlrpcresp fault (1) + // isf_reason - used for storing xmlrpcresp fault string + // lv - used to indicate "looking for a value": implements + // the logic to allow values with no types to be strings + // params - used to store parameters in method calls + // method - used to store method name + // stack - array with genealogy of xml elements names: + // used to validate nesting of xmlrpc elements + $GLOBALS['_xh']=null; + + /** + * Convert a string to the correct XML representation in a target charset + * To help correct communication of non-ascii chars inside strings, regardless + * of the charset used when sending requests, parsing them, sending responses + * and parsing responses, an option is to convert all non-ascii chars present in the message + * into their equivalent 'charset entity'. Charset entities enumerated this way + * are independent of the charset encoding used to transmit them, and all XML + * parsers are bound to understand them. + * Note that in the std case we are not sending a charset encoding mime type + * along with http headers, so we are bound by RFC 3023 to emit strict us-ascii. + * + * @todo do a bit of basic benchmarking (strtr vs. str_replace) + * @todo make usage of iconv() or recode_string() or mb_string() where available + */ + function xmlrpc_encode_entitites($data, $src_encoding='', $dest_encoding='') + { + if ($src_encoding == '') + { + // lame, but we know no better... + $src_encoding = $GLOBALS['xmlrpc_internalencoding']; + } + + switch(strtoupper($src_encoding.'_'.$dest_encoding)) + { + case 'ISO-8859-1_': + case 'ISO-8859-1_US-ASCII': + $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); + $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data); + break; + case 'ISO-8859-1_UTF-8': + $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); + $escaped_data = utf8_encode($escaped_data); + break; + case 'ISO-8859-1_ISO-8859-1': + case 'US-ASCII_US-ASCII': + case 'US-ASCII_UTF-8': + case 'US-ASCII_': + case 'US-ASCII_ISO-8859-1': + case 'UTF-8_UTF-8': + //case 'CP1252_CP1252': + $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); + break; + case 'UTF-8_': + case 'UTF-8_US-ASCII': + case 'UTF-8_ISO-8859-1': + // NB: this will choke on invalid UTF-8, going most likely beyond EOF + $escaped_data = ''; + // be kind to users creating string xmlrpcvals out of different php types + $data = (string) $data; + $ns = strlen ($data); + for ($nn = 0; $nn < $ns; $nn++) + { + $ch = $data[$nn]; + $ii = ord($ch); + //1 7 0bbbbbbb (127) + if ($ii < 128) + { + /// @todo shall we replace this with a (supposedly) faster str_replace? + switch($ii){ + case 34: + $escaped_data .= '"'; + break; + case 38: + $escaped_data .= '&'; + break; + case 39: + $escaped_data .= '''; + break; + case 60: + $escaped_data .= '<'; + break; + case 62: + $escaped_data .= '>'; + break; + default: + $escaped_data .= $ch; + } // switch + } + //2 11 110bbbbb 10bbbbbb (2047) + else if ($ii>>5 == 6) + { + $b1 = ($ii & 31); + $ii = ord($data[$nn+1]); + $b2 = ($ii & 63); + $ii = ($b1 * 64) + $b2; + $ent = sprintf ('&#%d;', $ii); + $escaped_data .= $ent; + $nn += 1; + } + //3 16 1110bbbb 10bbbbbb 10bbbbbb + else if ($ii>>4 == 14) + { + $b1 = ($ii & 15); + $ii = ord($data[$nn+1]); + $b2 = ($ii & 63); + $ii = ord($data[$nn+2]); + $b3 = ($ii & 63); + $ii = ((($b1 * 64) + $b2) * 64) + $b3; + $ent = sprintf ('&#%d;', $ii); + $escaped_data .= $ent; + $nn += 2; + } + //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb + else if ($ii>>3 == 30) + { + $b1 = ($ii & 7); + $ii = ord($data[$nn+1]); + $b2 = ($ii & 63); + $ii = ord($data[$nn+2]); + $b3 = ($ii & 63); + $ii = ord($data[$nn+3]); + $b4 = ($ii & 63); + $ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4; + $ent = sprintf ('&#%d;', $ii); + $escaped_data .= $ent; + $nn += 3; + } + } + break; +/* + case 'CP1252_': + case 'CP1252_US-ASCII': + $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); + $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data); + $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data); + break; + case 'CP1252_UTF-8': + $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); + /// @todo we could use real UTF8 chars here instead of xml entities... (note that utf_8 encode all allone will NOT convert them) + $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data); + $escaped_data = utf8_encode($escaped_data); + break; + case 'CP1252_ISO-8859-1': + $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); + // we might as well replave all funky chars with a '?' here, but we are kind and leave it to the receiving application layer to decide what to do with these weird entities... + $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data); + break; +*/ + default: + $escaped_data = ''; + error_log("Converting from $src_encoding to $dest_encoding: not supported..."); + } + return $escaped_data; + } + + /// xml parser handler function for opening element tags + function xmlrpc_se($parser, $name, $attrs, $accept_single_vals=false) + { + // if invalid xmlrpc already detected, skip all processing + if ($GLOBALS['_xh']['isf'] < 2) + { + // check for correct element nesting + // top level element can only be of 2 types + /// @todo optimization creep: save this check into a bool variable, instead of using count() every time: + /// there is only a single top level element in xml anyway + if (count($GLOBALS['_xh']['stack']) == 0) + { + if ($name != 'METHODRESPONSE' && $name != 'METHODCALL' && ( + $name != 'VALUE' && !$accept_single_vals)) + { + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = 'missing top level xmlrpc element'; + return; + } + else + { + $GLOBALS['_xh']['rt'] = strtolower($name); + } + } + else + { + // not top level element: see if parent is OK + $parent = end($GLOBALS['_xh']['stack']); + if (!array_key_exists($name, $GLOBALS['xmlrpc_valid_parents']) || !in_array($parent, $GLOBALS['xmlrpc_valid_parents'][$name])) + { + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "xmlrpc element $name cannot be child of $parent"; + return; + } + } + + switch($name) + { + // optimize for speed switch cases: most common cases first + case 'VALUE': + /// @todo we could check for 2 VALUE elements inside a MEMBER or PARAM element + $GLOBALS['_xh']['vt']='value'; // indicator: no value found yet + $GLOBALS['_xh']['ac']=''; + $GLOBALS['_xh']['lv']=1; + $GLOBALS['_xh']['php_class']=null; + break; + case 'I4': + case 'INT': + case 'STRING': + case 'BOOLEAN': + case 'DOUBLE': + case 'DATETIME.ISO8601': + case 'BASE64': + if ($GLOBALS['_xh']['vt']!='value') + { + //two data elements inside a value: an error occurred! + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value"; + return; + } + $GLOBALS['_xh']['ac']=''; // reset the accumulator + break; + case 'STRUCT': + case 'ARRAY': + if ($GLOBALS['_xh']['vt']!='value') + { + //two data elements inside a value: an error occurred! + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value"; + return; + } + // create an empty array to hold child values, and push it onto appropriate stack + $cur_val = array(); + $cur_val['values'] = array(); + $cur_val['type'] = $name; + // check for out-of-band information to rebuild php objs + // and in case it is found, save it + if (@isset($attrs['PHP_CLASS'])) + { + $cur_val['php_class'] = $attrs['PHP_CLASS']; + } + $GLOBALS['_xh']['valuestack'][] = $cur_val; + $GLOBALS['_xh']['vt']='data'; // be prepared for a data element next + break; + case 'DATA': + if ($GLOBALS['_xh']['vt']!='data') + { + //two data elements inside a value: an error occurred! + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "found two data elements inside an array element"; + return; + } + case 'METHODCALL': + case 'METHODRESPONSE': + case 'PARAMS': + // valid elements that add little to processing + break; + case 'METHODNAME': + case 'NAME': + /// @todo we could check for 2 NAME elements inside a MEMBER element + $GLOBALS['_xh']['ac']=''; + break; + case 'FAULT': + $GLOBALS['_xh']['isf']=1; + break; + case 'MEMBER': + $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name']=''; // set member name to null, in case we do not find in the xml later on + //$GLOBALS['_xh']['ac']=''; + // Drop trough intentionally + case 'PARAM': + // clear value type, so we can check later if no value has been passed for this param/member + $GLOBALS['_xh']['vt']=null; + break; + case 'NIL': + if ($GLOBALS['xmlrpc_null_extension']) + { + if ($GLOBALS['_xh']['vt']!='value') + { + //two data elements inside a value: an error occurred! + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value"; + return; + } + $GLOBALS['_xh']['ac']=''; // reset the accumulator + break; + } + // we do not support the extension, so + // drop through intentionally + default: + /// INVALID ELEMENT: RAISE ISF so that it is later recognized!!! + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "found not-xmlrpc xml element $name"; + break; + } + + // Save current element name to stack, to validate nesting + $GLOBALS['_xh']['stack'][] = $name; + + /// @todo optimization creep: move this inside the big switch() above + if($name!='VALUE') + { + $GLOBALS['_xh']['lv']=0; + } + } + } + + /// Used in decoding xml chunks that might represent single xmlrpc values + function xmlrpc_se_any($parser, $name, $attrs) + { + xmlrpc_se($parser, $name, $attrs, true); + } + + /// xml parser handler function for close element tags + function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true) + { + if ($GLOBALS['_xh']['isf'] < 2) + { + // push this element name from stack + // NB: if XML validates, correct opening/closing is guaranteed and + // we do not have to check for $name == $curr_elem. + // we also checked for proper nesting at start of elements... + $curr_elem = array_pop($GLOBALS['_xh']['stack']); + + switch($name) + { + case 'VALUE': + // This if() detects if no scalar was inside + if ($GLOBALS['_xh']['vt']=='value') + { + $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac']; + $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcString']; + } + + if ($rebuild_xmlrpcvals) + { + // build the xmlrpc val out of the data received, and substitute it + $temp =& new xmlrpcval($GLOBALS['_xh']['value'], $GLOBALS['_xh']['vt']); + // in case we got info about underlying php class, save it + // in the object we're rebuilding + if (isset($GLOBALS['_xh']['php_class'])) + $temp->_php_class = $GLOBALS['_xh']['php_class']; + // check if we are inside an array or struct: + // if value just built is inside an array, let's move it into array on the stack + $vscount = count($GLOBALS['_xh']['valuestack']); + if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY') + { + $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $temp; + } + else + { + $GLOBALS['_xh']['value'] = $temp; + } + } + else + { + /// @todo this needs to treat correctly php-serialized objects, + /// since std deserializing is done by php_xmlrpc_decode, + /// which we will not be calling... + if (isset($GLOBALS['_xh']['php_class'])) + { + } + + // check if we are inside an array or struct: + // if value just built is inside an array, let's move it into array on the stack + $vscount = count($GLOBALS['_xh']['valuestack']); + if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY') + { + $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $GLOBALS['_xh']['value']; + } + } + break; + case 'BOOLEAN': + case 'I4': + case 'INT': + case 'STRING': + case 'DOUBLE': + case 'DATETIME.ISO8601': + case 'BASE64': + $GLOBALS['_xh']['vt']=strtolower($name); + /// @todo: optimization creep - remove the if/elseif cycle below + /// since the case() in which we are already did that + if ($name=='STRING') + { + $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac']; + } + elseif ($name=='DATETIME.ISO8601') + { + if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $GLOBALS['_xh']['ac'])) + { + error_log('XML-RPC: invalid value received in DATETIME: '.$GLOBALS['_xh']['ac']); + } + $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcDateTime']; + $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac']; + } + elseif ($name=='BASE64') + { + /// @todo check for failure of base64 decoding / catch warnings + $GLOBALS['_xh']['value']=base64_decode($GLOBALS['_xh']['ac']); + } + elseif ($name=='BOOLEAN') + { + // special case here: we translate boolean 1 or 0 into PHP + // constants true or false. + // Strings 'true' and 'false' are accepted, even though the + // spec never mentions them (see eg. Blogger api docs) + // NB: this simple checks helps a lot sanitizing input, ie no + // security problems around here + if ($GLOBALS['_xh']['ac']=='1' || strcasecmp($GLOBALS['_xh']['ac'], 'true') == 0) + { + $GLOBALS['_xh']['value']=true; + } + else + { + // log if receiveing something strange, even though we set the value to false anyway + if ($GLOBALS['_xh']['ac']!='0' && strcasecmp($GLOBALS['_xh']['ac'], 'false') != 0) + error_log('XML-RPC: invalid value received in BOOLEAN: '.$GLOBALS['_xh']['ac']); + $GLOBALS['_xh']['value']=false; + } + } + elseif ($name=='DOUBLE') + { + // we have a DOUBLE + // we must check that only 0123456789-. are characters here + // NOTE: regexp could be much stricter than this... + if (!preg_match('/^[+-eE0123456789 \t.]+$/', $GLOBALS['_xh']['ac'])) + { + /// @todo: find a better way of throwing an error than this! + error_log('XML-RPC: non numeric value received in DOUBLE: '.$GLOBALS['_xh']['ac']); + $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND'; + } + else + { + // it's ok, add it on + $GLOBALS['_xh']['value']=(double)$GLOBALS['_xh']['ac']; + } + } + else + { + // we have an I4/INT + // we must check that only 0123456789- are characters here + if (!preg_match('/^[+-]?[0123456789 \t]+$/', $GLOBALS['_xh']['ac'])) + { + /// @todo find a better way of throwing an error than this! + error_log('XML-RPC: non numeric value received in INT: '.$GLOBALS['_xh']['ac']); + $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND'; + } + else + { + // it's ok, add it on + $GLOBALS['_xh']['value']=(int)$GLOBALS['_xh']['ac']; + } + } + //$GLOBALS['_xh']['ac']=''; // is this necessary? + $GLOBALS['_xh']['lv']=3; // indicate we've found a value + break; + case 'NAME': + $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name'] = $GLOBALS['_xh']['ac']; + break; + case 'MEMBER': + //$GLOBALS['_xh']['ac']=''; // is this necessary? + // add to array in the stack the last element built, + // unless no VALUE was found + if ($GLOBALS['_xh']['vt']) + { + $vscount = count($GLOBALS['_xh']['valuestack']); + $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][$GLOBALS['_xh']['valuestack'][$vscount-1]['name']] = $GLOBALS['_xh']['value']; + } else + error_log('XML-RPC: missing VALUE inside STRUCT in received xml'); + break; + case 'DATA': + //$GLOBALS['_xh']['ac']=''; // is this necessary? + $GLOBALS['_xh']['vt']=null; // reset this to check for 2 data elements in a row - even if they're empty + break; + case 'STRUCT': + case 'ARRAY': + // fetch out of stack array of values, and promote it to current value + $curr_val = array_pop($GLOBALS['_xh']['valuestack']); + $GLOBALS['_xh']['value'] = $curr_val['values']; + $GLOBALS['_xh']['vt']=strtolower($name); + if (isset($curr_val['php_class'])) + { + $GLOBALS['_xh']['php_class'] = $curr_val['php_class']; + } + break; + case 'PARAM': + // add to array of params the current value, + // unless no VALUE was found + if ($GLOBALS['_xh']['vt']) + { + $GLOBALS['_xh']['params'][]=$GLOBALS['_xh']['value']; + $GLOBALS['_xh']['pt'][]=$GLOBALS['_xh']['vt']; + } + else + error_log('XML-RPC: missing VALUE inside PARAM in received xml'); + break; + case 'METHODNAME': + $GLOBALS['_xh']['method']=preg_replace('/^[\n\r\t ]+/', '', $GLOBALS['_xh']['ac']); + break; + case 'NIL': + if ($GLOBALS['xmlrpc_null_extension']) + { + $GLOBALS['_xh']['vt']='null'; + $GLOBALS['_xh']['value']=null; + $GLOBALS['_xh']['lv']=3; + break; + } + // drop through intentionally if nil extension not enabled + case 'PARAMS': + case 'FAULT': + case 'METHODCALL': + case 'METHORESPONSE': + break; + default: + // End of INVALID ELEMENT! + // shall we add an assert here for unreachable code??? + break; + } + } + } + + /// Used in decoding xmlrpc requests/responses without rebuilding xmlrpc values + function xmlrpc_ee_fast($parser, $name) + { + xmlrpc_ee($parser, $name, false); + } + + /// xml parser handler function for character data + function xmlrpc_cd($parser, $data) + { + // skip processing if xml fault already detected + if ($GLOBALS['_xh']['isf'] < 2) + { + // "lookforvalue==3" means that we've found an entire value + // and should discard any further character data + if($GLOBALS['_xh']['lv']!=3) + { + // G. Giunta 2006-08-23: useless change of 'lv' from 1 to 2 + //if($GLOBALS['_xh']['lv']==1) + //{ + // if we've found text and we're just in a then + // say we've found a value + //$GLOBALS['_xh']['lv']=2; + //} + // we always initialize the accumulator before starting parsing, anyway... + //if(!@isset($GLOBALS['_xh']['ac'])) + //{ + // $GLOBALS['_xh']['ac'] = ''; + //} + $GLOBALS['_xh']['ac'].=$data; + } + } + } + + /// xml parser handler function for 'other stuff', ie. not char data or + /// element start/end tag. In fact it only gets called on unknown entities... + function xmlrpc_dh($parser, $data) + { + // skip processing if xml fault already detected + if ($GLOBALS['_xh']['isf'] < 2) + { + if(substr($data, 0, 1) == '&' && substr($data, -1, 1) == ';') + { + // G. Giunta 2006-08-25: useless change of 'lv' from 1 to 2 + //if($GLOBALS['_xh']['lv']==1) + //{ + // $GLOBALS['_xh']['lv']=2; + //} + $GLOBALS['_xh']['ac'].=$data; + } + } + return true; + } + + class xmlrpc_client + { + var $path; + var $server; + var $port=0; + var $method='http'; + var $errno; + var $errstr; + var $debug=0; + var $username=''; + var $password=''; + var $authtype=1; + var $cert=''; + var $certpass=''; + var $cacert=''; + var $cacertdir=''; + var $key=''; + var $keypass=''; + var $verifypeer=true; + var $verifyhost=1; + var $no_multicall=false; + var $proxy=''; + var $proxyport=0; + var $proxy_user=''; + var $proxy_pass=''; + var $proxy_authtype=1; + var $cookies=array(); + /** + * List of http compression methods accepted by the client for responses. + * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib + * + * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since + * in those cases it will be up to CURL to decide the compression methods + * it supports. You might check for the presence of 'zlib' in the output of + * curl_version() to determine wheter compression is supported or not + */ + var $accepted_compression = array(); + /** + * Name of compression scheme to be used for sending requests. + * Either null, gzip or deflate + */ + var $request_compression = ''; + /** + * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see: + * http://curl.haxx.se/docs/faq.html#7.3) + */ + var $xmlrpc_curl_handle = null; + /// Wheter to use persistent connections for http 1.1 and https + var $keepalive = false; + /// Charset encodings that can be decoded without problems by the client + var $accepted_charset_encodings = array(); + /// Charset encoding to be used in serializing request. NULL = use ASCII + var $request_charset_encoding = ''; + /** + * Decides the content of xmlrpcresp objects returned by calls to send() + * valid strings are 'xmlrpcvals', 'phpvals' or 'xml' + */ + var $return_type = 'xmlrpcvals'; + + /** + * @param string $path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php + * @param string $server the server name / ip address + * @param integer $port the port the server is listening on, defaults to 80 or 443 depending on protocol used + * @param string $method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed + */ + function xmlrpc_client($path, $server='', $port='', $method='') + { + // allow user to specify all params in $path + if($server == '' and $port == '' and $method == '') + { + $parts = parse_url($path); + $server = $parts['host']; + $path = isset($parts['path']) ? $parts['path'] : ''; + if(isset($parts['query'])) + { + $path .= '?'.$parts['query']; + } + if(isset($parts['fragment'])) + { + $path .= '#'.$parts['fragment']; + } + if(isset($parts['port'])) + { + $port = $parts['port']; + } + if(isset($parts['scheme'])) + { + $method = $parts['scheme']; + } + if(isset($parts['user'])) + { + $this->username = $parts['user']; + } + if(isset($parts['pass'])) + { + $this->password = $parts['pass']; + } + } + if($path == '' || $path[0] != '/') + { + $this->path='/'.$path; + } + else + { + $this->path=$path; + } + $this->server=$server; + if($port != '') + { + $this->port=$port; + } + if($method != '') + { + $this->method=$method; + } + + // if ZLIB is enabled, let the client by default accept compressed responses + if(function_exists('gzinflate') || ( + function_exists('curl_init') && (($info = curl_version()) && + ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version']))) + )) + { + $this->accepted_compression = array('gzip', 'deflate'); + } + + // keepalives: enabled by default ONLY for PHP >= 4.3.8 + // (see http://curl.haxx.se/docs/faq.html#7.3) + if(version_compare(phpversion(), '4.3.8') >= 0) + { + $this->keepalive = true; + } + + // by default the xml parser can support these 3 charset encodings + $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII'); + } + + /** + * Enables/disables the echoing to screen of the xmlrpc responses received + * @param integer $debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response) + * @access public + */ + function setDebug($in) + { + $this->debug=$in; + } + + /** + * Add some http BASIC AUTH credentials, used by the client to authenticate + * @param string $u username + * @param string $p password + * @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth) + * @access public + */ + function setCredentials($u, $p, $t=1) + { + $this->username=$u; + $this->password=$p; + $this->authtype=$t; + } + + /** + * Add a client-side https certificate + * @param string $cert + * @param string $certpass + * @access public + */ + function setCertificate($cert, $certpass) + { + $this->cert = $cert; + $this->certpass = $certpass; + } + + /** + * Add a CA certificate to verify server with (see man page about + * CURLOPT_CAINFO for more details + * @param string $cacert certificate file name (or dir holding certificates) + * @param bool $is_dir set to true to indicate cacert is a dir. defaults to false + * @access public + */ + function setCaCertificate($cacert, $is_dir=false) + { + if ($is_dir) + { + $this->cacertdir = $cacert; + } + else + { + $this->cacert = $cacert; + } + } + + /** + * Set attributes for SSL communication: private SSL key + * NB: does not work in older php/curl installs + * Thanks to Daniel Convissor + * @param string $key The name of a file containing a private SSL key + * @param string $keypass The secret password needed to use the private SSL key + * @access public + */ + function setKey($key, $keypass) + { + $this->key = $key; + $this->keypass = $keypass; + } + + /** + * Set attributes for SSL communication: verify server certificate + * @param bool $i enable/disable verification of peer certificate + * @access public + */ + function setSSLVerifyPeer($i) + { + $this->verifypeer = $i; + } + + /** + * Set attributes for SSL communication: verify match of server cert w. hostname + * @param int $i + * @access public + */ + function setSSLVerifyHost($i) + { + $this->verifyhost = $i; + } + + /** + * Set proxy info + * @param string $proxyhost + * @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS + * @param string $proxyusername Leave blank if proxy has public access + * @param string $proxypassword Leave blank if proxy has public access + * @param int $proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy + * @access public + */ + function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1) + { + $this->proxy = $proxyhost; + $this->proxyport = $proxyport; + $this->proxy_user = $proxyusername; + $this->proxy_pass = $proxypassword; + $this->proxy_authtype = $proxyauthtype; + } + + /** + * Enables/disables reception of compressed xmlrpc responses. + * Note that enabling reception of compressed responses merely adds some standard + * http headers to xmlrpc requests. It is up to the xmlrpc server to return + * compressed responses when receiving such requests. + * @param string $compmethod either 'gzip', 'deflate', 'any' or '' + * @access public + */ + function setAcceptedCompression($compmethod) + { + if ($compmethod == 'any') + $this->accepted_compression = array('gzip', 'deflate'); + else + $this->accepted_compression = array($compmethod); + } + + /** + * Enables/disables http compression of xmlrpc request. + * Take care when sending compressed requests: servers might not support them + * (and automatic fallback to uncompressed requests is not yet implemented) + * @param string $compmethod either 'gzip', 'deflate' or '' + * @access public + */ + function setRequestCompression($compmethod) + { + $this->request_compression = $compmethod; + } + + /** + * Adds a cookie to list of cookies that will be sent to server. + * NB: setting any param but name and value will turn the cookie into a 'version 1' cookie: + * do not do it unless you know what you are doing + * @param string $name + * @param string $value + * @param string $path + * @param string $domain + * @param int $port + * @access public + * + * @todo check correctness of urlencoding cookie value (copied from php way of doing it...) + */ + function setCookie($name, $value='', $path='', $domain='', $port=null) + { + $this->cookies[$name]['value'] = urlencode($value); + if ($path || $domain || $port) + { + $this->cookies[$name]['path'] = $path; + $this->cookies[$name]['domain'] = $domain; + $this->cookies[$name]['port'] = $port; + $this->cookies[$name]['version'] = 1; + } + else + { + $this->cookies[$name]['version'] = 0; + } + } + + /** + * Send an xmlrpc request + * @param mixed $msg The message object, or an array of messages for using multicall, or the complete xml representation of a request + * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply + * @param string $method if left unspecified, the http protocol chosen during creation of the object will be used + * @return xmlrpcresp + * @access public + */ + function& send($msg, $timeout=0, $method='') + { + // if user deos not specify http protocol, use native method of this client + // (i.e. method set during call to constructor) + if($method == '') + { + $method = $this->method; + } + + if(is_array($msg)) + { + // $msg is an array of xmlrpcmsg's + $r = $this->multicall($msg, $timeout, $method); + return $r; + } + elseif(is_string($msg)) + { + $n =& new xmlrpcmsg(''); + $n->payload = $msg; + $msg = $n; + } + + // where msg is an xmlrpcmsg + $msg->debug=$this->debug; + + if($method == 'https') + { + $r =& $this->sendPayloadHTTPS( + $msg, + $this->server, + $this->port, + $timeout, + $this->username, + $this->password, + $this->authtype, + $this->cert, + $this->certpass, + $this->cacert, + $this->cacertdir, + $this->proxy, + $this->proxyport, + $this->proxy_user, + $this->proxy_pass, + $this->proxy_authtype, + $this->keepalive, + $this->key, + $this->keypass + ); + } + elseif($method == 'http11') + { + $r =& $this->sendPayloadCURL( + $msg, + $this->server, + $this->port, + $timeout, + $this->username, + $this->password, + $this->authtype, + null, + null, + null, + null, + $this->proxy, + $this->proxyport, + $this->proxy_user, + $this->proxy_pass, + $this->proxy_authtype, + 'http', + $this->keepalive + ); + } + else + { + $r =& $this->sendPayloadHTTP10( + $msg, + $this->server, + $this->port, + $timeout, + $this->username, + $this->password, + $this->authtype, + $this->proxy, + $this->proxyport, + $this->proxy_user, + $this->proxy_pass, + $this->proxy_authtype + ); + } + + return $r; + } + + /** + * @access private + */ + function &sendPayloadHTTP10($msg, $server, $port, $timeout=0, + $username='', $password='', $authtype=1, $proxyhost='', + $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1) + { + if($port==0) + { + $port=80; + } + + // Only create the payload if it was not created previously + if(empty($msg->payload)) + { + $msg->createPayload($this->request_charset_encoding); + } + + $payload = $msg->payload; + // Deflate request body and set appropriate request headers + if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) + { + if($this->request_compression == 'gzip') + { + $a = @gzencode($payload); + if($a) + { + $payload = $a; + $encoding_hdr = "Content-Encoding: gzip\r\n"; + } + } + else + { + $a = @gzcompress($payload); + if($a) + { + $payload = $a; + $encoding_hdr = "Content-Encoding: deflate\r\n"; + } + } + } + else + { + $encoding_hdr = ''; + } + + // thanks to Grant Rauscher for this + $credentials=''; + if($username!='') + { + $credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n"; + if ($authtype != 1) + { + error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported with HTTP 1.0'); + } + } + + $accepted_encoding = ''; + if(is_array($this->accepted_compression) && count($this->accepted_compression)) + { + $accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n"; + } + + $proxy_credentials = ''; + if($proxyhost) + { + if($proxyport == 0) + { + $proxyport = 8080; + } + $connectserver = $proxyhost; + $connectport = $proxyport; + $uri = 'http://'.$server.':'.$port.$this->path; + if($proxyusername != '') + { + if ($proxyauthtype != 1) + { + error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported with HTTP 1.0'); + } + $proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername.':'.$proxypassword) . "\r\n"; + } + } + else + { + $connectserver = $server; + $connectport = $port; + $uri = $this->path; + } + + // Cookie generation, as per rfc2965 (version 1 cookies) or + // netscape's rules (version 0 cookies) + $cookieheader=''; + if (count($this->cookies)) + { + $version = ''; + foreach ($this->cookies as $name => $cookie) + { + if ($cookie['version']) + { + $version = ' $Version="' . $cookie['version'] . '";'; + $cookieheader .= ' ' . $name . '="' . $cookie['value'] . '";'; + if ($cookie['path']) + $cookieheader .= ' $Path="' . $cookie['path'] . '";'; + if ($cookie['domain']) + $cookieheader .= ' $Domain="' . $cookie['domain'] . '";'; + if ($cookie['port']) + $cookieheader .= ' $Port="' . $cookie['port'] . '";'; + } + else + { + $cookieheader .= ' ' . $name . '=' . $cookie['value'] . ";"; + } + } + $cookieheader = 'Cookie:' . $version . substr($cookieheader, 0, -1) . "\r\n"; + } + + $op= 'POST ' . $uri. " HTTP/1.0\r\n" . + 'User-Agent: ' . $GLOBALS['xmlrpcName'] . ' ' . $GLOBALS['xmlrpcVersion'] . "\r\n" . + 'Host: '. $server . ':' . $port . "\r\n" . + $credentials . + $proxy_credentials . + $accepted_encoding . + $encoding_hdr . + 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" . + $cookieheader . + 'Content-Type: ' . $msg->content_type . "\r\nContent-Length: " . + strlen($payload) . "\r\n\r\n" . + $payload; + + if($this->debug > 1) + { + print "
\n---SENDING---\n" . htmlentities($op) . "\n---END---\n
"; + // let the client see this now in case http times out... + flush(); + } + + if($timeout>0) + { + $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout); + } + else + { + $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr); + } + if($fp) + { + if($timeout>0 && function_exists('stream_set_timeout')) + { + stream_set_timeout($fp, $timeout); + } + } + else + { + $this->errstr='Connect error: '.$this->errstr; + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr . ' (' . $this->errno . ')'); + return $r; + } + + if(!fputs($fp, $op, strlen($op))) + { + fclose($fp); + $this->errstr='Write error'; + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr); + return $r; + } + else + { + // reset errno and errstr on succesful socket connection + $this->errstr = ''; + } + // G. Giunta 2005/10/24: close socket before parsing. + // should yeld slightly better execution times, and make easier recursive calls (e.g. to follow http redirects) + $ipd=''; + do + { + // shall we check for $data === FALSE? + // as per the manual, it signals an error + $ipd.=fread($fp, 32768); + } while(!feof($fp)); + fclose($fp); + $r =& $msg->parseResponse($ipd, false, $this->return_type); + return $r; + + } + + /** + * @access private + */ + function &sendPayloadHTTPS($msg, $server, $port, $timeout=0, $username='', + $password='', $authtype=1, $cert='',$certpass='', $cacert='', $cacertdir='', + $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, + $keepalive=false, $key='', $keypass='') + { + $r =& $this->sendPayloadCURL($msg, $server, $port, $timeout, $username, + $password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport, + $proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass); + return $r; + } + + /** + * Contributed by Justin Miller + * Requires curl to be built into PHP + * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers! + * @access private + */ + function &sendPayloadCURL($msg, $server, $port, $timeout=0, $username='', + $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='', + $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https', + $keepalive=false, $key='', $keypass='') + { + if(!function_exists('curl_init')) + { + $this->errstr='CURL unavailable on this install'; + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_curl'], $GLOBALS['xmlrpcstr']['no_curl']); + return $r; + } + if($method == 'https') + { + if(($info = curl_version()) && + ((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version'])))) + { + $this->errstr='SSL unavailable on this install'; + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_ssl'], $GLOBALS['xmlrpcstr']['no_ssl']); + return $r; + } + } + + if($port == 0) + { + if($method == 'http') + { + $port = 80; + } + else + { + $port = 443; + } + } + + // Only create the payload if it was not created previously + if(empty($msg->payload)) + { + $msg->createPayload($this->request_charset_encoding); + } + + // Deflate request body and set appropriate request headers + $payload = $msg->payload; + if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) + { + if($this->request_compression == 'gzip') + { + $a = @gzencode($payload); + if($a) + { + $payload = $a; + $encoding_hdr = 'Content-Encoding: gzip'; + } + } + else + { + $a = @gzcompress($payload); + if($a) + { + $payload = $a; + $encoding_hdr = 'Content-Encoding: deflate'; + } + } + } + else + { + $encoding_hdr = ''; + } + + if($this->debug > 1) + { + print "
\n---SENDING---\n" . htmlentities($payload) . "\n---END---\n
"; + // let the client see this now in case http times out... + flush(); + } + + if(!$keepalive || !$this->xmlrpc_curl_handle) + { + $curl = curl_init($method . '://' . $server . ':' . $port . $this->path); + if($keepalive) + { + $this->xmlrpc_curl_handle = $curl; + } + } + else + { + $curl = $this->xmlrpc_curl_handle; + } + + // results into variable + curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); + + if($this->debug) + { + curl_setopt($curl, CURLOPT_VERBOSE, 1); + } + curl_setopt($curl, CURLOPT_USERAGENT, $GLOBALS['xmlrpcName'].' '.$GLOBALS['xmlrpcVersion']); + // required for XMLRPC: post the data + curl_setopt($curl, CURLOPT_POST, 1); + // the data + curl_setopt($curl, CURLOPT_POSTFIELDS, $payload); + + // return the header too + curl_setopt($curl, CURLOPT_HEADER, 1); + + // will only work with PHP >= 5.0 + // NB: if we set an empty string, CURL will add http header indicating + // ALL methods it is supporting. This is possibly a better option than + // letting the user tell what curl can / cannot do... + if(is_array($this->accepted_compression) && count($this->accepted_compression)) + { + //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression)); + // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?) + if (count($this->accepted_compression) == 1) + { + curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]); + } + else + curl_setopt($curl, CURLOPT_ENCODING, ''); + } + // extra headers + $headers = array('Content-Type: ' . $msg->content_type , 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings)); + // if no keepalive is wanted, let the server know it in advance + if(!$keepalive) + { + $headers[] = 'Connection: close'; + } + // request compression header + if($encoding_hdr) + { + $headers[] = $encoding_hdr; + } + + curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); + // timeout is borked + if($timeout) + { + curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1); + } + + if($username && $password) + { + curl_setopt($curl, CURLOPT_USERPWD, $username.':'.$password); + if (defined('CURLOPT_HTTPAUTH')) + { + curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype); + } + else if ($authtype != 1) + { + error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported by the current PHP/curl install'); + } + } + + if($method == 'https') + { + // set cert file + if($cert) + { + curl_setopt($curl, CURLOPT_SSLCERT, $cert); + } + // set cert password + if($certpass) + { + curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certpass); + } + // whether to verify remote host's cert + curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer); + // set ca certificates file/dir + if($cacert) + { + curl_setopt($curl, CURLOPT_CAINFO, $cacert); + } + if($cacertdir) + { + curl_setopt($curl, CURLOPT_CAPATH, $cacertdir); + } + // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?) + if($key) + { + curl_setopt($curl, CURLOPT_SSLKEY, $key); + } + // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?) + if($keypass) + { + curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass); + } + // whether to verify cert's common name (CN); 0 for no, 1 to verify that it exists, and 2 to verify that it matches the hostname used + curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost); + } + + // proxy info + if($proxyhost) + { + if($proxyport == 0) + { + $proxyport = 8080; // NB: even for HTTPS, local connection is on port 8080 + } + curl_setopt($curl, CURLOPT_PROXY, $proxyhost.':'.$proxyport); + //curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport); + if($proxyusername) + { + curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.':'.$proxypassword); + if (defined('CURLOPT_PROXYAUTH')) + { + curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype); + } + else if ($proxyauthtype != 1) + { + error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported by the current PHP/curl install'); + } + } + } + + // NB: should we build cookie http headers by hand rather than let CURL do it? + // the following code does not honour 'expires', 'path' and 'domain' cookie attributes + // set to client obj the the user... + if (count($this->cookies)) + { + $cookieheader = ''; + foreach ($this->cookies as $name => $cookie) + { + $cookieheader .= $name . '=' . $cookie['value'] . '; '; + } + curl_setopt($curl, CURLOPT_COOKIE, substr($cookieheader, 0, -2)); + } + + $result = curl_exec($curl); + + if ($this->debug > 1) + { + print "
\n---CURL INFO---\n";
+				foreach(curl_getinfo($curl) as $name => $val)
+					 print $name . ': ' . htmlentities($val). "\n";
+				print "---END---\n
"; + } + + if(!$result) /// @todo we should use a better check here - what if we get back '' or '0'? + { + $this->errstr='no response'; + $resp=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['curl_fail'], $GLOBALS['xmlrpcstr']['curl_fail']. ': '. curl_error($curl)); + curl_close($curl); + if($keepalive) + { + $this->xmlrpc_curl_handle = null; + } + } + else + { + if(!$keepalive) + { + curl_close($curl); + } + $resp =& $msg->parseResponse($result, true, $this->return_type); + } + return $resp; + } + + /** + * Send an array of request messages and return an array of responses. + * Unless $this->no_multicall has been set to true, it will try first + * to use one single xmlrpc call to server method system.multicall, and + * revert to sending many successive calls in case of failure. + * This failure is also stored in $this->no_multicall for subsequent calls. + * Unfortunately, there is no server error code universally used to denote + * the fact that multicall is unsupported, so there is no way to reliably + * distinguish between that and a temporary failure. + * If you are sure that server supports multicall and do not want to + * fallback to using many single calls, set the fourth parameter to FALSE. + * + * NB: trying to shoehorn extra functionality into existing syntax has resulted + * in pretty much convoluted code... + * + * @param array $msgs an array of xmlrpcmsg objects + * @param integer $timeout connection timeout (in seconds) + * @param string $method the http protocol variant to be used + * @param boolean fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted + * @return array + * @access public + */ + function multicall($msgs, $timeout=0, $method='', $fallback=true) + { + if ($method == '') + { + $method = $this->method; + } + if(!$this->no_multicall) + { + $results = $this->_try_multicall($msgs, $timeout, $method); + if(is_array($results)) + { + // System.multicall succeeded + return $results; + } + else + { + // either system.multicall is unsupported by server, + // or call failed for some other reason. + if ($fallback) + { + // Don't try it next time... + $this->no_multicall = true; + } + else + { + if (is_a($results, 'xmlrpcresp')) + { + $result = $results; + } + else + { + $result =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['multicall_error'], $GLOBALS['xmlrpcstr']['multicall_error']); + } + } + } + } + else + { + // override fallback, in case careless user tries to do two + // opposite things at the same time + $fallback = true; + } + + $results = array(); + if ($fallback) + { + // system.multicall is (probably) unsupported by server: + // emulate multicall via multiple requests + foreach($msgs as $msg) + { + $results[] =& $this->send($msg, $timeout, $method); + } + } + else + { + // user does NOT want to fallback on many single calls: + // since we should always return an array of responses, + // return an array with the same error repeated n times + foreach($msgs as $msg) + { + $results[] = $result; + } + } + return $results; + } + + /** + * Attempt to boxcar $msgs via system.multicall. + * Returns either an array of xmlrpcreponses, an xmlrpc error response + * or false (when received response does not respect valid multicall syntax) + * @access private + */ + function _try_multicall($msgs, $timeout, $method) + { + // Construct multicall message + $calls = array(); + foreach($msgs as $msg) + { + $call['methodName'] =& new xmlrpcval($msg->method(),'string'); + $numParams = $msg->getNumParams(); + $params = array(); + for($i = 0; $i < $numParams; $i++) + { + $params[$i] = $msg->getParam($i); + } + $call['params'] =& new xmlrpcval($params, 'array'); + $calls[] =& new xmlrpcval($call, 'struct'); + } + $multicall =& new xmlrpcmsg('system.multicall'); + $multicall->addParam(new xmlrpcval($calls, 'array')); + + // Attempt RPC call + $result =& $this->send($multicall, $timeout, $method); + + if($result->faultCode() != 0) + { + // call to system.multicall failed + return $result; + } + + // Unpack responses. + $rets = $result->value(); + + if ($this->return_type == 'xml') + { + return $rets; + } + else if ($this->return_type == 'phpvals') + { + ///@todo test this code branch... + $rets = $result->value(); + if(!is_array($rets)) + { + return false; // bad return type from system.multicall + } + $numRets = count($rets); + if($numRets != count($msgs)) + { + return false; // wrong number of return values. + } + + $response = array(); + for($i = 0; $i < $numRets; $i++) + { + $val = $rets[$i]; + if (!is_array($val)) { + return false; + } + switch(count($val)) + { + case 1: + if(!isset($val[0])) + { + return false; // Bad value + } + // Normal return value + $response[$i] =& new xmlrpcresp($val[0], 0, '', 'phpvals'); + break; + case 2: + /// @todo remove usage of @: it is apparently quite slow + $code = @$val['faultCode']; + if(!is_int($code)) + { + return false; + } + $str = @$val['faultString']; + if(!is_string($str)) + { + return false; + } + $response[$i] =& new xmlrpcresp(0, $code, $str); + break; + default: + return false; + } + } + return $response; + } + else // return type == 'xmlrpcvals' + { + $rets = $result->value(); + if($rets->kindOf() != 'array') + { + return false; // bad return type from system.multicall + } + $numRets = $rets->arraysize(); + if($numRets != count($msgs)) + { + return false; // wrong number of return values. + } + + $response = array(); + for($i = 0; $i < $numRets; $i++) + { + $val = $rets->arraymem($i); + switch($val->kindOf()) + { + case 'array': + if($val->arraysize() != 1) + { + return false; // Bad value + } + // Normal return value + $response[$i] =& new xmlrpcresp($val->arraymem(0)); + break; + case 'struct': + $code = $val->structmem('faultCode'); + if($code->kindOf() != 'scalar' || $code->scalartyp() != 'int') + { + return false; + } + $str = $val->structmem('faultString'); + if($str->kindOf() != 'scalar' || $str->scalartyp() != 'string') + { + return false; + } + $response[$i] =& new xmlrpcresp(0, $code->scalarval(), $str->scalarval()); + break; + default: + return false; + } + } + return $response; + } + } + } // end class xmlrpc_client + + class xmlrpcresp + { + var $val = 0; + var $valtyp; + var $errno = 0; + var $errstr = ''; + var $payload; + var $hdrs = array(); + var $_cookies = array(); + var $content_type = 'text/xml'; + var $raw_data = ''; + + /** + * @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string) + * @param integer $fcode set it to anything but 0 to create an error response + * @param string $fstr the error string, in case of an error response + * @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml' + * + * @todo add check that $val / $fcode / $fstr is of correct type??? + * NB: as of now we do not do it, since it might be either an xmlrpcval or a plain + * php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called... + */ + function xmlrpcresp($val, $fcode = 0, $fstr = '', $valtyp='') + { + if($fcode != 0) + { + // error response + $this->errno = $fcode; + $this->errstr = $fstr; + //$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later. + } + else + { + // successful response + $this->val = $val; + if ($valtyp == '') + { + // user did not declare type of response value: try to guess it + if (is_object($this->val) && is_a($this->val, 'xmlrpcval')) + { + $this->valtyp = 'xmlrpcvals'; + } + else if (is_string($this->val)) + { + $this->valtyp = 'xml'; + + } + else + { + $this->valtyp = 'phpvals'; + } + } + else + { + // user declares type of resp value: believe him + $this->valtyp = $valtyp; + } + } + } + + /** + * Returns the error code of the response. + * @return integer the error code of this response (0 for not-error responses) + * @access public + */ + function faultCode() + { + return $this->errno; + } + + /** + * Returns the error code of the response. + * @return string the error string of this response ('' for not-error responses) + * @access public + */ + function faultString() + { + return $this->errstr; + } + + /** + * Returns the value received by the server. + * @return mixed the xmlrpcval object returned by the server. Might be an xml string or php value if the response has been created by specially configured xmlrpc_client objects + * @access public + */ + function value() + { + return $this->val; + } + + /** + * Returns an array with the cookies received from the server. + * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...) + * with attributes being e.g. 'expires', 'path', domain'. + * NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past) + * are still present in the array. It is up to the user-defined code to decide + * how to use the received cookies, and wheter they have to be sent back with the next + * request to the server (using xmlrpc_client::setCookie) or not + * @return array array of cookies received from the server + * @access public + */ + function cookies() + { + return $this->_cookies; + } + + /** + * Returns xml representation of the response. XML prologue not included + * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed + * @return string the xml representation of the response + * @access public + */ + function serialize($charset_encoding='') + { + if ($charset_encoding != '') + $this->content_type = 'text/xml; charset=' . $charset_encoding; + else + $this->content_type = 'text/xml'; + $result = "\n"; + if($this->errno) + { + // G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients + // by xml-encoding non ascii chars + $result .= "\n" . +"\nfaultCode\n" . $this->errno . +"\n\n\nfaultString\n" . +xmlrpc_encode_entitites($this->errstr, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding) . "\n\n" . +"\n\n"; + } + else + { + if(!is_object($this->val) || !is_a($this->val, 'xmlrpcval')) + { + if (is_string($this->val) && $this->valtyp == 'xml') + { + $result .= "\n\n" . + $this->val . + "\n"; + } + else + { + /// @todo try to build something serializable? + die('cannot serialize xmlrpcresp objects whose content is native php values'); + } + } + else + { + $result .= "\n\n" . + $this->val->serialize($charset_encoding) . + "\n"; + } + } + $result .= "\n"; + $this->payload = $result; + return $result; + } + } + + class xmlrpcmsg + { + var $payload; + var $methodname; + var $params=array(); + var $debug=0; + var $content_type = 'text/xml'; + + /** + * @param string $meth the name of the method to invoke + * @param array $pars array of parameters to be paased to the method (xmlrpcval objects) + */ + function xmlrpcmsg($meth, $pars=0) + { + $this->methodname=$meth; + if(is_array($pars) && count($pars)>0) + { + for($i=0; $iaddParam($pars[$i]); + } + } + } + + /** + * @access private + */ + function xml_header($charset_encoding='') + { + if ($charset_encoding != '') + { + return "\n\n"; + } + else + { + return "\n\n"; + } + } + + /** + * @access private + */ + function xml_footer() + { + return ''; + } + + /** + * @access private + */ + function kindOf() + { + return 'msg'; + } + + /** + * @access private + */ + function createPayload($charset_encoding='') + { + if ($charset_encoding != '') + $this->content_type = 'text/xml; charset=' . $charset_encoding; + else + $this->content_type = 'text/xml'; + $this->payload=$this->xml_header($charset_encoding); + $this->payload.='' . $this->methodname . "\n"; + $this->payload.="\n"; + for($i=0; $iparams); $i++) + { + $p=$this->params[$i]; + $this->payload.="\n" . $p->serialize($charset_encoding) . + "\n"; + } + $this->payload.="\n"; + $this->payload.=$this->xml_footer(); + } + + /** + * Gets/sets the xmlrpc method to be invoked + * @param string $meth the method to be set (leave empty not to set it) + * @return string the method that will be invoked + * @access public + */ + function method($meth='') + { + if($meth!='') + { + $this->methodname=$meth; + } + return $this->methodname; + } + + /** + * Returns xml representation of the message. XML prologue included + * @return string the xml representation of the message, xml prologue included + * @access public + */ + function serialize($charset_encoding='') + { + $this->createPayload($charset_encoding); + return $this->payload; + } + + /** + * Add a parameter to the list of parameters to be used upon method invocation + * @param xmlrpcval $par + * @return boolean false on failure + * @access public + */ + function addParam($par) + { + // add check: do not add to self params which are not xmlrpcvals + if(is_object($par) && is_a($par, 'xmlrpcval')) + { + $this->params[]=$par; + return true; + } + else + { + return false; + } + } + + /** + * Returns the nth parameter in the message. The index zero-based. + * @param integer $i the index of the parameter to fetch (zero based) + * @return xmlrpcval the i-th parameter + * @access public + */ + function getParam($i) { return $this->params[$i]; } + + /** + * Returns the number of parameters in the messge. + * @return integer the number of parameters currently set + * @access public + */ + function getNumParams() { return count($this->params); } + + /** + * Given an open file handle, read all data available and parse it as axmlrpc response. + * NB: the file handle is not closed by this function. + * NNB: might have trouble in rare cases to work on network streams, as we + * check for a read of 0 bytes instead of feof($fp). + * But since checking for feof(null) returns false, we would risk an + * infinite loop in that case, because we cannot trust the caller + * to give us a valid pointer to an open file... + * @access public + * @return xmlrpcresp + * @todo add 2nd & 3rd param to be passed to ParseResponse() ??? + */ + function &parseResponseFile($fp) + { + $ipd=''; + while($data=fread($fp, 32768)) + { + $ipd.=$data; + } + //fclose($fp); + $r =& $this->parseResponse($ipd); + return $r; + } + + /** + * Parses HTTP headers and separates them from data. + * @access private + */ + function &parseResponseHeaders(&$data, $headers_processed=false) + { + // Support "web-proxy-tunelling" connections for https through proxies + if(preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data)) + { + // Look for CR/LF or simple LF as line separator, + // (even though it is not valid http) + $pos = strpos($data,"\r\n\r\n"); + if($pos || is_int($pos)) + { + $bd = $pos+4; + } + else + { + $pos = strpos($data,"\n\n"); + if($pos || is_int($pos)) + { + $bd = $pos+2; + } + else + { + // No separation between response headers and body: fault? + $bd = 0; + } + } + if ($bd) + { + // this filters out all http headers from proxy. + // maybe we could take them into account, too? + $data = substr($data, $bd); + } + else + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTPS via proxy error, tunnel connection possibly failed'); + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (HTTPS via proxy error, tunnel connection possibly failed)'); + return $r; + } + } + + // Strip HTTP 1.1 100 Continue header if present + while(preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data)) + { + $pos = strpos($data, 'HTTP', 12); + // server sent a Continue header without any (valid) content following... + // give the client a chance to know it + if(!$pos && !is_int($pos)) // works fine in php 3, 4 and 5 + { + break; + } + $data = substr($data, $pos); + } + if(!preg_match('/^HTTP\/[0-9.]+ 200 /', $data)) + { + $errstr= substr($data, 0, strpos($data, "\n")-1); + error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTP error, got response: ' .$errstr); + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (' . $errstr . ')'); + return $r; + } + + $GLOBALS['_xh']['headers'] = array(); + $GLOBALS['_xh']['cookies'] = array(); + + // be tolerant to usage of \n instead of \r\n to separate headers and data + // (even though it is not valid http) + $pos = strpos($data,"\r\n\r\n"); + if($pos || is_int($pos)) + { + $bd = $pos+4; + } + else + { + $pos = strpos($data,"\n\n"); + if($pos || is_int($pos)) + { + $bd = $pos+2; + } + else + { + // No separation between response headers and body: fault? + // we could take some action here instead of going on... + $bd = 0; + } + } + // be tolerant to line endings, and extra empty lines + $ar = split("\r?\n", trim(substr($data, 0, $pos))); + while(list(,$line) = @each($ar)) + { + // take care of multi-line headers and cookies + $arr = explode(':',$line,2); + if(count($arr) > 1) + { + $header_name = strtolower(trim($arr[0])); + /// @todo some other headers (the ones that allow a CSV list of values) + /// do allow many values to be passed using multiple header lines. + /// We should add content to $GLOBALS['_xh']['headers'][$header_name] + /// instead of replacing it for those... + if ($header_name == 'set-cookie' || $header_name == 'set-cookie2') + { + if ($header_name == 'set-cookie2') + { + // version 2 cookies: + // there could be many cookies on one line, comma separated + $cookies = explode(',', $arr[1]); + } + else + { + $cookies = array($arr[1]); + } + foreach ($cookies as $cookie) + { + // glue together all received cookies, using a comma to separate them + // (same as php does with getallheaders()) + if (isset($GLOBALS['_xh']['headers'][$header_name])) + $GLOBALS['_xh']['headers'][$header_name] .= ', ' . trim($cookie); + else + $GLOBALS['_xh']['headers'][$header_name] = trim($cookie); + // parse cookie attributes, in case user wants to correctly honour them + // feature creep: only allow rfc-compliant cookie attributes? + // @todo support for server sending multiple time cookie with same name, but using different PATHs + $cookie = explode(';', $cookie); + foreach ($cookie as $pos => $val) + { + $val = explode('=', $val, 2); + $tag = trim($val[0]); + $val = trim(@$val[1]); + /// @todo with version 1 cookies, we should strip leading and trailing " chars + if ($pos == 0) + { + $cookiename = $tag; + $GLOBALS['_xh']['cookies'][$tag] = array(); + $GLOBALS['_xh']['cookies'][$cookiename]['value'] = urldecode($val); + } + else + { + if ($tag != 'value') + { + $GLOBALS['_xh']['cookies'][$cookiename][$tag] = $val; + } + } + } + } + } + else + { + $GLOBALS['_xh']['headers'][$header_name] = trim($arr[1]); + } + } + elseif(isset($header_name)) + { + /// @todo version1 cookies might span multiple lines, thus breaking the parsing above + $GLOBALS['_xh']['headers'][$header_name] .= ' ' . trim($line); + } + } + + $data = substr($data, $bd); + + if($this->debug && count($GLOBALS['_xh']['headers'])) + { + print '
';
+					foreach($GLOBALS['_xh']['headers'] as $header => $value)
+					{
+						print htmlentities("HEADER: $header: $value\n");
+					}
+					foreach($GLOBALS['_xh']['cookies'] as $header => $value)
+					{
+						print htmlentities("COOKIE: $header={$value['value']}\n");
+					}
+					print "
\n"; + } + + // if CURL was used for the call, http headers have been processed, + // and dechunking + reinflating have been carried out + if(!$headers_processed) + { + // Decode chunked encoding sent by http 1.1 servers + if(isset($GLOBALS['_xh']['headers']['transfer-encoding']) && $GLOBALS['_xh']['headers']['transfer-encoding'] == 'chunked') + { + if(!$data = decode_chunked($data)) + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to rebuild the chunked data received from server'); + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['dechunk_fail'], $GLOBALS['xmlrpcstr']['dechunk_fail']); + return $r; + } + } + + // Decode gzip-compressed stuff + // code shamelessly inspired from nusoap library by Dietrich Ayala + if(isset($GLOBALS['_xh']['headers']['content-encoding'])) + { + $GLOBALS['_xh']['headers']['content-encoding'] = str_replace('x-', '', $GLOBALS['_xh']['headers']['content-encoding']); + if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' || $GLOBALS['_xh']['headers']['content-encoding'] == 'gzip') + { + // if decoding works, use it. else assume data wasn't gzencoded + if(function_exists('gzinflate')) + { + if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data)) + { + $data = $degzdata; + if($this->debug) + print "
---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---
"; + } + elseif($GLOBALS['_xh']['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) + { + $data = $degzdata; + if($this->debug) + print "
---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---
"; + } + else + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to decode the deflated data received from server'); + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['decompress_fail'], $GLOBALS['xmlrpcstr']['decompress_fail']); + return $r; + } + } + else + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: the server sent deflated data. Your php install must have the Zlib extension compiled in to support this.'); + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['cannot_decompress'], $GLOBALS['xmlrpcstr']['cannot_decompress']); + return $r; + } + } + } + } // end of 'if needed, de-chunk, re-inflate response' + + // real stupid hack to avoid PHP 4 complaining about returning NULL by ref + $r = null; + $r =& $r; + return $r; + } + + /** + * Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object. + * @param string $data the xmlrpc response, eventually including http headers + * @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding + * @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals' + * @return xmlrpcresp + * @access public + */ + function &parseResponse($data='', $headers_processed=false, $return_type='xmlrpcvals') + { + if($this->debug) + { + //by maHo, replaced htmlspecialchars with htmlentities + print "
---GOT---\n" . htmlentities($data) . "\n---END---\n
"; + } + + if($data == '') + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: no response received from server.'); + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_data'], $GLOBALS['xmlrpcstr']['no_data']); + return $r; + } + + $GLOBALS['_xh']=array(); + + $raw_data = $data; + // parse the HTTP headers of the response, if present, and separate them from data + if(substr($data, 0, 4) == 'HTTP') + { + $r =& $this->parseResponseHeaders($data, $headers_processed); + if ($r) + { + // failed processing of HTTP response headers + // save into response obj the full payload received, for debugging + $r->raw_data = $data; + return $r; + } + } + else + { + $GLOBALS['_xh']['headers'] = array(); + $GLOBALS['_xh']['cookies'] = array(); + } + + if($this->debug) + { + $start = strpos($data, '', $start); + $comments = substr($data, $start, $end-$start); + print "
---SERVER DEBUG INFO (DECODED) ---\n\t".htmlentities(str_replace("\n", "\n\t", base64_decode($comments)))."\n---END---\n
"; + } + } + + // be tolerant of extra whitespace in response body + $data = trim($data); + + /// @todo return an error msg if $data=='' ? + + // be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts) + // idea from Luca Mariano originally in PEARified version of the lib + $bd = false; + // Poor man's version of strrpos for php 4... + $pos = strpos($data, ''); + while($pos || is_int($pos)) + { + $bd = $pos+17; + $pos = strpos($data, '', $bd); + } + if($bd) + { + $data = substr($data, 0, $bd); + } + + // if user wants back raw xml, give it to him + if ($return_type == 'xml') + { + $r =& new xmlrpcresp($data, 0, '', 'xml'); + $r->hdrs = $GLOBALS['_xh']['headers']; + $r->_cookies = $GLOBALS['_xh']['cookies']; + $r->raw_data = $raw_data; + return $r; + } + + // try to 'guestimate' the character encoding of the received response + $resp_encoding = guess_encoding(@$GLOBALS['_xh']['headers']['content-type'], $data); + + $GLOBALS['_xh']['ac']=''; + //$GLOBALS['_xh']['qt']=''; //unused... + $GLOBALS['_xh']['stack'] = array(); + $GLOBALS['_xh']['valuestack'] = array(); + $GLOBALS['_xh']['isf']=0; // 0 = OK, 1 for xmlrpc fault responses, 2 = invalid xmlrpc + $GLOBALS['_xh']['isf_reason']=''; + $GLOBALS['_xh']['rt']=''; // 'methodcall or 'methodresponse' + + // if response charset encoding is not known / supported, try to use + // the default encoding and parse the xml anyway, but log a warning... + if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) + // the following code might be better for mb_string enabled installs, but + // makes the lib about 200% slower... + //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: invalid charset encoding of received response: '.$resp_encoding); + $resp_encoding = $GLOBALS['xmlrpc_defencoding']; + } + $parser = xml_parser_create($resp_encoding); + xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true); + // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell + // the xml parser to give us back data in the expected charset. + // What if internal encoding is not in one of the 3 allowed? + // we use the broadest one, ie. utf8 + // This allows to send data which is native in various charset, + // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding + if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) + { + xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8'); + } + else + { + xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']); + } + + if ($return_type == 'phpvals') + { + xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast'); + } + else + { + xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee'); + } + + xml_set_character_data_handler($parser, 'xmlrpc_cd'); + xml_set_default_handler($parser, 'xmlrpc_dh'); + + // first error check: xml not well formed + if(!xml_parse($parser, $data, count($data))) + { + // thanks to Peter Kocks + if((xml_get_current_line_number($parser)) == 1) + { + $errstr = 'XML error at line 1, check URL'; + } + else + { + $errstr = sprintf('XML error: %s at line %d, column %d', + xml_error_string(xml_get_error_code($parser)), + xml_get_current_line_number($parser), xml_get_current_column_number($parser)); + } + error_log($errstr); + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], $GLOBALS['xmlrpcstr']['invalid_return'].' ('.$errstr.')'); + xml_parser_free($parser); + if($this->debug) + { + print $errstr; + } + $r->hdrs = $GLOBALS['_xh']['headers']; + $r->_cookies = $GLOBALS['_xh']['cookies']; + $r->raw_data = $raw_data; + return $r; + } + xml_parser_free($parser); + // second error check: xml well formed but not xml-rpc compliant + if ($GLOBALS['_xh']['isf'] > 1) + { + if ($this->debug) + { + /// @todo echo something for user? + } + + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], + $GLOBALS['xmlrpcstr']['invalid_return'] . ' ' . $GLOBALS['_xh']['isf_reason']); + } + // third error check: parsing of the response has somehow gone boink. + // NB: shall we omit this check, since we trust the parsing code? + elseif ($return_type == 'xmlrpcvals' && !is_object($GLOBALS['_xh']['value'])) + { + // something odd has happened + // and it's time to generate a client side error + // indicating something odd went on + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], + $GLOBALS['xmlrpcstr']['invalid_return']); + } + else + { + if ($this->debug) + { + print "
---PARSED---\n";
+					// somehow htmlentities chokes on var_export, and some full html string...
+					//print htmlentitites(var_export($GLOBALS['_xh']['value'], true));
+					print htmlspecialchars(var_export($GLOBALS['_xh']['value'], true));
+					print "\n---END---
"; + } + + // note that using =& will raise an error if $GLOBALS['_xh']['st'] does not generate an object. + $v =& $GLOBALS['_xh']['value']; + + if($GLOBALS['_xh']['isf']) + { + /// @todo we should test here if server sent an int and a string, + /// and/or coerce them into such... + if ($return_type == 'xmlrpcvals') + { + $errno_v = $v->structmem('faultCode'); + $errstr_v = $v->structmem('faultString'); + $errno = $errno_v->scalarval(); + $errstr = $errstr_v->scalarval(); + } + else + { + $errno = $v['faultCode']; + $errstr = $v['faultString']; + } + + if($errno == 0) + { + // FAULT returned, errno needs to reflect that + $errno = -1; + } + + $r =& new xmlrpcresp(0, $errno, $errstr); + } + else + { + $r=&new xmlrpcresp($v, 0, '', $return_type); + } + } + + $r->hdrs = $GLOBALS['_xh']['headers']; + $r->_cookies = $GLOBALS['_xh']['cookies']; + $r->raw_data = $raw_data; + return $r; + } + } + + class xmlrpcval + { + var $me=array(); + var $mytype=0; + var $_php_class=null; + + /** + * @param mixed $val + * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed + */ + function xmlrpcval($val=-1, $type='') + { + /// @todo: optimization creep - do not call addXX, do it all inline. + /// downside: booleans will not be coerced anymore + if($val!==-1 || $type!='') + { + // optimization creep: inlined all work done by constructor + switch($type) + { + case '': + $this->mytype=1; + $this->me['string']=$val; + break; + case 'i4': + case 'int': + case 'double': + case 'string': + case 'boolean': + case 'dateTime.iso8601': + case 'base64': + case 'null': + $this->mytype=1; + $this->me[$type]=$val; + break; + case 'array': + $this->mytype=2; + $this->me['array']=$val; + break; + case 'struct': + $this->mytype=3; + $this->me['struct']=$val; + break; + default: + error_log("XML-RPC: xmlrpcval::xmlrpcval: not a known type ($type)"); + } + /*if($type=='') + { + $type='string'; + } + if($GLOBALS['xmlrpcTypes'][$type]==1) + { + $this->addScalar($val,$type); + } + elseif($GLOBALS['xmlrpcTypes'][$type]==2) + { + $this->addArray($val); + } + elseif($GLOBALS['xmlrpcTypes'][$type]==3) + { + $this->addStruct($val); + }*/ + } + } + + /** + * Add a single php value to an (unitialized) xmlrpcval + * @param mixed $val + * @param string $type + * @return int 1 or 0 on failure + */ + function addScalar($val, $type='string') + { + $typeof=@$GLOBALS['xmlrpcTypes'][$type]; + if($typeof!=1) + { + error_log("XML-RPC: xmlrpcval::addScalar: not a scalar type ($type)"); + return 0; + } + + // coerce booleans into correct values + // NB: we should iether do it for datetimes, integers and doubles, too, + // or just plain remove this check, implemnted on booleans only... + if($type==$GLOBALS['xmlrpcBoolean']) + { + if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false'))) + { + $val=true; + } + else + { + $val=false; + } + } + + switch($this->mytype) + { + case 1: + error_log('XML-RPC: xmlrpcval::addScalar: scalar xmlrpcval can have only one value'); + return 0; + case 3: + error_log('XML-RPC: xmlrpcval::addScalar: cannot add anonymous scalar to struct xmlrpcval'); + return 0; + case 2: + // we're adding a scalar value to an array here + //$ar=$this->me['array']; + //$ar[]=&new xmlrpcval($val, $type); + //$this->me['array']=$ar; + // Faster (?) avoid all the costly array-copy-by-val done here... + $this->me['array'][]=&new xmlrpcval($val, $type); + return 1; + default: + // a scalar, so set the value and remember we're scalar + $this->me[$type]=$val; + $this->mytype=$typeof; + return 1; + } + } + + /** + * Add an array of xmlrpcval objects to an xmlrpcval + * @param array $vals + * @return int 1 or 0 on failure + * @access public + * + * @todo add some checking for $vals to be an array of xmlrpcvals? + */ + function addArray($vals) + { + if($this->mytype==0) + { + $this->mytype=$GLOBALS['xmlrpcTypes']['array']; + $this->me['array']=$vals; + return 1; + } + elseif($this->mytype==2) + { + // we're adding to an array here + $this->me['array'] = array_merge($this->me['array'], $vals); + return 1; + } + else + { + error_log('XML-RPC: xmlrpcval::addArray: already initialized as a [' . $this->kindOf() . ']'); + return 0; + } + } + + /** + * Add an array of named xmlrpcval objects to an xmlrpcval + * @param array $vals + * @return int 1 or 0 on failure + * @access public + * + * @todo add some checking for $vals to be an array? + */ + function addStruct($vals) + { + if($this->mytype==0) + { + $this->mytype=$GLOBALS['xmlrpcTypes']['struct']; + $this->me['struct']=$vals; + return 1; + } + elseif($this->mytype==3) + { + // we're adding to a struct here + $this->me['struct'] = array_merge($this->me['struct'], $vals); + return 1; + } + else + { + error_log('XML-RPC: xmlrpcval::addStruct: already initialized as a [' . $this->kindOf() . ']'); + return 0; + } + } + + // poor man's version of print_r ??? + // DEPRECATED! + function dump($ar) + { + foreach($ar as $key => $val) + { + echo "$key => $val
"; + if($key == 'array') + { + while(list($key2, $val2) = each($val)) + { + echo "-- $key2 => $val2
"; + } + } + } + } + + /** + * Returns a string containing "struct", "array" or "scalar" describing the base type of the value + * @return string + * @access public + */ + function kindOf() + { + switch($this->mytype) + { + case 3: + return 'struct'; + break; + case 2: + return 'array'; + break; + case 1: + return 'scalar'; + break; + default: + return 'undef'; + } + } + + /** + * @access private + */ + function serializedata($typ, $val, $charset_encoding='') + { + $rs=''; + switch(@$GLOBALS['xmlrpcTypes'][$typ]) + { + case 1: + switch($typ) + { + case $GLOBALS['xmlrpcBase64']: + $rs.="<${typ}>" . base64_encode($val) . ""; + break; + case $GLOBALS['xmlrpcBoolean']: + $rs.="<${typ}>" . ($val ? '1' : '0') . ""; + break; + case $GLOBALS['xmlrpcString']: + // G. Giunta 2005/2/13: do NOT use htmlentities, since + // it will produce named html entities, which are invalid xml + $rs.="<${typ}>" . xmlrpc_encode_entitites($val, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding). ""; + break; + case $GLOBALS['xmlrpcInt']: + case $GLOBALS['xmlrpcI4']: + $rs.="<${typ}>".(int)$val.""; + break; + case $GLOBALS['xmlrpcDouble']: + // avoid using standard conversion of float to string because it is locale-dependent, + // and also because the xmlrpc spec forbids exponential notation + // sprintf('%F') would be most likely ok but it is only available since PHP 4.3.10 and PHP 5.0.3. + // The code below tries its best at keeping max precision while avoiding exp notation, + // but there is of course no limit in the number of decimal places to be used... + $rs.="<${typ}>".preg_replace('/\\.?0+$/','',number_format((double)$val, 128, '.', '')).""; + break; + case $GLOBALS['xmlrpcNull']: + $rs.=""; + break; + default: + // no standard type value should arrive here, but provide a possibility + // for xmlrpcvals of unknown type... + $rs.="<${typ}>${val}"; + } + break; + case 3: + // struct + if ($this->_php_class) + { + $rs.='\n"; + } + else + { + $rs.="\n"; + } + foreach($val as $key2 => $val2) + { + $rs.=''.xmlrpc_encode_entitites($key2, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding)."\n"; + //$rs.=$this->serializeval($val2); + $rs.=$val2->serialize($charset_encoding); + $rs.="\n"; + } + $rs.=''; + break; + case 2: + // array + $rs.="\n\n"; + for($i=0; $iserializeval($val[$i]); + $rs.=$val[$i]->serialize($charset_encoding); + } + $rs.="\n"; + break; + default: + break; + } + return $rs; + } + + /** + * Returns xml representation of the value. XML prologue not included + * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed + * @return string + * @access public + */ + function serialize($charset_encoding='') + { + // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals... + //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval'))) + //{ + reset($this->me); + list($typ, $val) = each($this->me); + return '' . $this->serializedata($typ, $val, $charset_encoding) . "\n"; + //} + } + + // DEPRECATED + function serializeval($o) + { + // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals... + //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval'))) + //{ + $ar=$o->me; + reset($ar); + list($typ, $val) = each($ar); + return '' . $this->serializedata($typ, $val) . "\n"; + //} + } + + /** + * Checks wheter a struct member with a given name is present. + * Works only on xmlrpcvals of type struct. + * @param string $m the name of the struct member to be looked up + * @return boolean + * @access public + */ + function structmemexists($m) + { + return array_key_exists($m, $this->me['struct']); + } + + /** + * Returns the value of a given struct member (an xmlrpcval object in itself). + * Will raise a php warning if struct member of given name does not exist + * @param string $m the name of the struct member to be looked up + * @return xmlrpcval + * @access public + */ + function structmem($m) + { + return $this->me['struct'][$m]; + } + + /** + * Reset internal pointer for xmlrpcvals of type struct. + * @access public + */ + function structreset() + { + reset($this->me['struct']); + } + + /** + * Return next member element for xmlrpcvals of type struct. + * @return xmlrpcval + * @access public + */ + function structeach() + { + return each($this->me['struct']); + } + + // DEPRECATED! this code looks like it is very fragile and has not been fixed + // for a long long time. Shall we remove it for 2.0? + function getval() + { + // UNSTABLE + reset($this->me); + list($a,$b)=each($this->me); + // contributed by I Sofer, 2001-03-24 + // add support for nested arrays to scalarval + // i've created a new method here, so as to + // preserve back compatibility + + if(is_array($b)) + { + @reset($b); + while(list($id,$cont) = @each($b)) + { + $b[$id] = $cont->scalarval(); + } + } + + // add support for structures directly encoding php objects + if(is_object($b)) + { + $t = get_object_vars($b); + @reset($t); + while(list($id,$cont) = @each($t)) + { + $t[$id] = $cont->scalarval(); + } + @reset($t); + while(list($id,$cont) = @each($t)) + { + @$b->$id = $cont; + } + } + // end contrib + return $b; + } + + /** + * Returns the value of a scalar xmlrpcval + * @return mixed + * @access public + */ + function scalarval() + { + reset($this->me); + list(,$b)=each($this->me); + return $b; + } + + /** + * Returns the type of the xmlrpcval. + * For integers, 'int' is always returned in place of 'i4' + * @return string + * @access public + */ + function scalartyp() + { + reset($this->me); + list($a,)=each($this->me); + if($a==$GLOBALS['xmlrpcI4']) + { + $a=$GLOBALS['xmlrpcInt']; + } + return $a; + } + + /** + * Returns the m-th member of an xmlrpcval of struct type + * @param integer $m the index of the value to be retrieved (zero based) + * @return xmlrpcval + * @access public + */ + function arraymem($m) + { + return $this->me['array'][$m]; + } + + /** + * Returns the number of members in an xmlrpcval of array type + * @return integer + * @access public + */ + function arraysize() + { + return count($this->me['array']); + } + + /** + * Returns the number of members in an xmlrpcval of struct type + * @return integer + * @access public + */ + function structsize() + { + return count($this->me['struct']); + } + } + + + // date helpers + + /** + * Given a timestamp, return the corresponding ISO8601 encoded string. + * + * Really, timezones ought to be supported + * but the XML-RPC spec says: + * + * "Don't assume a timezone. It should be specified by the server in its + * documentation what assumptions it makes about timezones." + * + * These routines always assume localtime unless + * $utc is set to 1, in which case UTC is assumed + * and an adjustment for locale is made when encoding + * + * @param int $timet (timestamp) + * @param int $utc (0 or 1) + * @return string + */ + function iso8601_encode($timet, $utc=0) + { + if(!$utc) + { + $t=strftime("%Y%m%dT%H:%M:%S", $timet); + } + else + { + if(function_exists('gmstrftime')) + { + // gmstrftime doesn't exist in some versions + // of PHP + $t=gmstrftime("%Y%m%dT%H:%M:%S", $timet); + } + else + { + $t=strftime("%Y%m%dT%H:%M:%S", $timet-date('Z')); + } + } + return $t; + } + + /** + * Given an ISO8601 date string, return a timet in the localtime, or UTC + * @param string $idate + * @param int $utc either 0 or 1 + * @return int (datetime) + */ + function iso8601_decode($idate, $utc=0) + { + $t=0; + if(preg_match('/([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})/', $idate, $regs)) + { + if($utc) + { + $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]); + } + else + { + $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]); + } + } + return $t; + } + + /** + * Takes an xmlrpc value in PHP xmlrpcval object format and translates it into native PHP types. + * + * Works with xmlrpc message objects as input, too. + * + * Given proper options parameter, can rebuild generic php object instances + * (provided those have been encoded to xmlrpc format using a corresponding + * option in php_xmlrpc_encode()) + * PLEASE NOTE that rebuilding php objects involves calling their constructor function. + * This means that the remote communication end can decide which php code will + * get executed on your server, leaving the door possibly open to 'php-injection' + * style of attacks (provided you have some classes defined on your server that + * might wreak havoc if instances are built outside an appropriate context). + * Make sure you trust the remote server/client before eanbling this! + * + * @author Dan Libby (dan@libby.com) + * + * @param xmlrpcval $xmlrpc_val + * @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects + * @return mixed + */ + function php_xmlrpc_decode($xmlrpc_val, $options=array()) + { + switch($xmlrpc_val->kindOf()) + { + case 'scalar': + if (in_array('extension_api', $options)) + { + reset($xmlrpc_val->me); + list($typ,$val) = each($xmlrpc_val->me); + switch ($typ) + { + case 'dateTime.iso8601': + $xmlrpc_val->scalar = $val; + $xmlrpc_val->xmlrpc_type = 'datetime'; + $xmlrpc_val->timestamp = iso8601_decode($val); + return $xmlrpc_val; + case 'base64': + $xmlrpc_val->scalar = $val; + $xmlrpc_val->type = $typ; + return $xmlrpc_val; + default: + return $xmlrpc_val->scalarval(); + } + } + return $xmlrpc_val->scalarval(); + case 'array': + $size = $xmlrpc_val->arraysize(); + $arr = array(); + for($i = 0; $i < $size; $i++) + { + $arr[] = php_xmlrpc_decode($xmlrpc_val->arraymem($i), $options); + } + return $arr; + case 'struct': + $xmlrpc_val->structreset(); + // If user said so, try to rebuild php objects for specific struct vals. + /// @todo should we raise a warning for class not found? + // shall we check for proper subclass of xmlrpcval instead of + // presence of _php_class to detect what we can do? + if (in_array('decode_php_objs', $options) && $xmlrpc_val->_php_class != '' + && class_exists($xmlrpc_val->_php_class)) + { + $obj = @new $xmlrpc_val->_php_class; + while(list($key,$value)=$xmlrpc_val->structeach()) + { + $obj->$key = php_xmlrpc_decode($value, $options); + } + return $obj; + } + else + { + $arr = array(); + while(list($key,$value)=$xmlrpc_val->structeach()) + { + $arr[$key] = php_xmlrpc_decode($value, $options); + } + return $arr; + } + case 'msg': + $paramcount = $xmlrpc_val->getNumParams(); + $arr = array(); + for($i = 0; $i < $paramcount; $i++) + { + $arr[] = php_xmlrpc_decode($xmlrpc_val->getParam($i)); + } + return $arr; + } + } + + // This constant left here only for historical reasons... + // it was used to decide if we have to define xmlrpc_encode on our own, but + // we do not do it anymore + if(function_exists('xmlrpc_decode')) + { + define('XMLRPC_EPI_ENABLED','1'); + } + else + { + define('XMLRPC_EPI_ENABLED','0'); + } + + /** + * Takes native php types and encodes them into xmlrpc PHP object format. + * It will not re-encode xmlrpcval objects. + * + * Feature creep -- could support more types via optional type argument + * (string => datetime support has been added, ??? => base64 not yet) + * + * If given a proper options parameter, php object instances will be encoded + * into 'special' xmlrpc values, that can later be decoded into php objects + * by calling php_xmlrpc_decode() with a corresponding option + * + * @author Dan Libby (dan@libby.com) + * + * @param mixed $php_val the value to be converted into an xmlrpcval object + * @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api' + * @return xmlrpcval + */ + function &php_xmlrpc_encode($php_val, $options=array()) + { + $type = gettype($php_val); + switch($type) + { + case 'string': + if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val)) + $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcDateTime']); + else + $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcString']); + break; + case 'integer': + $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcInt']); + break; + case 'double': + $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcDouble']); + break; + // + // Add support for encoding/decoding of booleans, since they are supported in PHP + case 'boolean': + $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcBoolean']); + break; + // + case 'array': + // PHP arrays can be encoded to either xmlrpc structs or arrays, + // depending on wheter they are hashes or plain 0..n integer indexed + // A shorter one-liner would be + // $tmp = array_diff(array_keys($php_val), range(0, count($php_val)-1)); + // but execution time skyrockets! + $j = 0; + $arr = array(); + $ko = false; + foreach($php_val as $key => $val) + { + $arr[$key] =& php_xmlrpc_encode($val, $options); + if(!$ko && $key !== $j) + { + $ko = true; + } + $j++; + } + if($ko) + { + $xmlrpc_val =& new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']); + } + else + { + $xmlrpc_val =& new xmlrpcval($arr, $GLOBALS['xmlrpcArray']); + } + break; + case 'object': + if(is_a($php_val, 'xmlrpcval')) + { + $xmlrpc_val = $php_val; + } + else + { + $arr = array(); + while(list($k,$v) = each($php_val)) + { + $arr[$k] = php_xmlrpc_encode($v, $options); + } + $xmlrpc_val =& new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']); + if (in_array('encode_php_objs', $options)) + { + // let's save original class name into xmlrpcval: + // might be useful later on... + $xmlrpc_val->_php_class = get_class($php_val); + } + } + break; + case 'NULL': + if (in_array('extension_api', $options)) + { + $xmlrpc_val =& new xmlrpcval('', $GLOBALS['xmlrpcString']); + } + if (in_array('null_extension', $options)) + { + $xmlrpc_val =& new xmlrpcval('', $GLOBALS['xmlrpcNull']); + } + else + { + $xmlrpc_val =& new xmlrpcval(); + } + break; + case 'resource': + if (in_array('extension_api', $options)) + { + $xmlrpc_val =& new xmlrpcval((int)$php_val, $GLOBALS['xmlrpcInt']); + } + else + { + $xmlrpc_val =& new xmlrpcval(); + } + // catch "user function", "unknown type" + default: + // giancarlo pinerolo + // it has to return + // an empty object in case, not a boolean. + $xmlrpc_val =& new xmlrpcval(); + break; + } + return $xmlrpc_val; + } + + /** + * Convert the xml representation of a method response, method request or single + * xmlrpc value into the appropriate object (a.k.a. deserialize) + * @param string $xml_val + * @param array $options + * @return mixed false on error, or an instance of either xmlrpcval, xmlrpcmsg or xmlrpcresp + */ + function php_xmlrpc_decode_xml($xml_val, $options=array()) + { + $GLOBALS['_xh'] = array(); + $GLOBALS['_xh']['ac'] = ''; + $GLOBALS['_xh']['stack'] = array(); + $GLOBALS['_xh']['valuestack'] = array(); + $GLOBALS['_xh']['params'] = array(); + $GLOBALS['_xh']['pt'] = array(); + $GLOBALS['_xh']['isf'] = 0; + $GLOBALS['_xh']['isf_reason'] = ''; + $GLOBALS['_xh']['method'] = false; + $GLOBALS['_xh']['rt'] = ''; + /// @todo 'guestimate' encoding + $parser = xml_parser_create(); + xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true); + // What if internal encoding is not in one of the 3 allowed? + // we use the broadest one, ie. utf8! + if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) + { + xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8'); + } + else + { + xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']); + } + xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee'); + xml_set_character_data_handler($parser, 'xmlrpc_cd'); + xml_set_default_handler($parser, 'xmlrpc_dh'); + if(!xml_parse($parser, $xml_val, 1)) + { + $errstr = sprintf('XML error: %s at line %d, column %d', + xml_error_string(xml_get_error_code($parser)), + xml_get_current_line_number($parser), xml_get_current_column_number($parser)); + error_log($errstr); + xml_parser_free($parser); + return false; + } + xml_parser_free($parser); + if ($GLOBALS['_xh']['isf'] > 1) // test that $GLOBALS['_xh']['value'] is an obj, too??? + { + error_log($GLOBALS['_xh']['isf_reason']); + return false; + } + switch ($GLOBALS['_xh']['rt']) + { + case 'methodresponse': + $v =& $GLOBALS['_xh']['value']; + if ($GLOBALS['_xh']['isf'] == 1) + { + $vc = $v->structmem('faultCode'); + $vs = $v->structmem('faultString'); + $r =& new xmlrpcresp(0, $vc->scalarval(), $vs->scalarval()); + } + else + { + $r =& new xmlrpcresp($v); + } + return $r; + case 'methodcall': + $m =& new xmlrpcmsg($GLOBALS['_xh']['method']); + for($i=0; $i < count($GLOBALS['_xh']['params']); $i++) + { + $m->addParam($GLOBALS['_xh']['params'][$i]); + } + return $m; + case 'value': + return $GLOBALS['_xh']['value']; + default: + return false; + } + } + + /** + * decode a string that is encoded w/ "chunked" transfer encoding + * as defined in rfc2068 par. 19.4.6 + * code shamelessly stolen from nusoap library by Dietrich Ayala + * + * @param string $buffer the string to be decoded + * @return string + */ + function decode_chunked($buffer) + { + // length := 0 + $length = 0; + $new = ''; + + // read chunk-size, chunk-extension (if any) and crlf + // get the position of the linebreak + $chunkend = strpos($buffer,"\r\n") + 2; + $temp = substr($buffer,0,$chunkend); + $chunk_size = hexdec( trim($temp) ); + $chunkstart = $chunkend; + while($chunk_size > 0) + { + $chunkend = strpos($buffer, "\r\n", $chunkstart + $chunk_size); + + // just in case we got a broken connection + if($chunkend == false) + { + $chunk = substr($buffer,$chunkstart); + // append chunk-data to entity-body + $new .= $chunk; + $length += strlen($chunk); + break; + } + + // read chunk-data and crlf + $chunk = substr($buffer,$chunkstart,$chunkend-$chunkstart); + // append chunk-data to entity-body + $new .= $chunk; + // length := length + chunk-size + $length += strlen($chunk); + // read chunk-size and crlf + $chunkstart = $chunkend + 2; + + $chunkend = strpos($buffer,"\r\n",$chunkstart)+2; + if($chunkend == false) + { + break; //just in case we got a broken connection + } + $temp = substr($buffer,$chunkstart,$chunkend-$chunkstart); + $chunk_size = hexdec( trim($temp) ); + $chunkstart = $chunkend; + } + return $new; + } + + /** + * xml charset encoding guessing helper function. + * Tries to determine the charset encoding of an XML chunk received over HTTP. + * NB: according to the spec (RFC 3023), if text/xml content-type is received over HTTP without a content-type, + * we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers, + * which will be most probably using UTF-8 anyway... + * + * @param string $httpheaders the http Content-type header + * @param string $xmlchunk xml content buffer + * @param string $encoding_prefs comma separated list of character encodings to be used as default (when mb extension is enabled) + * + * @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!! + */ + function guess_encoding($httpheader='', $xmlchunk='', $encoding_prefs=null) + { + // discussion: see http://www.yale.edu/pclt/encoding/ + // 1 - test if encoding is specified in HTTP HEADERS + + //Details: + // LWS: (\13\10)?( |\t)+ + // token: (any char but excluded stuff)+ + // quoted string: " (any char but double quotes and cointrol chars)* " + // header: Content-type = ...; charset=value(; ...)* + // where value is of type token, no LWS allowed between 'charset' and value + // Note: we do not check for invalid chars in VALUE: + // this had better be done using pure ereg as below + // Note 2: we might be removing whitespace/tabs that ought to be left in if + // the received charset is a quoted string. But nobody uses such charset names... + + /// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it? + $matches = array(); + if(preg_match('/;\s*charset\s*=([^;]+)/i', $httpheader, $matches)) + { + return strtoupper(trim($matches[1], " \t\"")); + } + + // 2 - scan the first bytes of the data for a UTF-16 (or other) BOM pattern + // (source: http://www.w3.org/TR/2000/REC-xml-20001006) + // NOTE: actually, according to the spec, even if we find the BOM and determine + // an encoding, we should check if there is an encoding specified + // in the xml declaration, and verify if they match. + /// @todo implement check as described above? + /// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM) + if(preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk)) + { + return 'UCS-4'; + } + elseif(preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk)) + { + return 'UTF-16'; + } + elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk)) + { + return 'UTF-8'; + } + + // 3 - test if encoding is specified in the xml declaration + // Details: + // SPACE: (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+ + // EQ: SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]* + if (preg_match('/^<\?xml\s+version\s*=\s*'. "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))". + '\s+encoding\s*=\s*' . "((?:\"[A-Za-z][A-Za-z0-9._-]*\")|(?:'[A-Za-z][A-Za-z0-9._-]*'))/", + $xmlchunk, $matches)) + { + return strtoupper(substr($matches[2], 1, -1)); + } + + // 4 - if mbstring is available, let it do the guesswork + // NB: we favour finding an encoding that is compatible with what we can process + if(extension_loaded('mbstring')) + { + if($encoding_prefs) + { + $enc = mb_detect_encoding($xmlchunk, $encoding_prefs); + } + else + { + $enc = mb_detect_encoding($xmlchunk); + } + // NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII... + // IANA also likes better US-ASCII, so go with it + if($enc == 'ASCII') + { + $enc = 'US-'.$enc; + } + return $enc; + } + else + { + // no encoding specified: as per HTTP1.1 assume it is iso-8859-1? + // Both RFC 2616 (HTTP 1.1) and 1945 (HTTP 1.0) clearly state that for text/xxx content types + // this should be the standard. And we should be getting text/xml as request and response. + // BUT we have to be backward compatible with the lib, which always used UTF-8 as default... + return $GLOBALS['xmlrpc_defencoding']; + } + } + + /** + * Checks if a given charset encoding is present in a list of encodings or + * if it is a valid subset of any encoding in the list + * @param string $encoding charset to be tested + * @param mixed $validlist comma separated list of valid charsets (or array of charsets) + */ + function is_valid_charset($encoding, $validlist) + { + $charset_supersets = array( + 'US-ASCII' => array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4', + 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8', + 'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12', + 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8', + 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN') + ); + if (is_string($validlist)) + $validlist = explode(',', $validlist); + if (@in_array(strtoupper($encoding), $validlist)) + return true; + else + { + if (array_key_exists($encoding, $charset_supersets)) + foreach ($validlist as $allowed) + if (in_array($allowed, $charset_supersets[$encoding])) + return true; + return false; + } + } + +?> \ No newline at end of file diff --git a/Moodle/mod/print/xmlrpc_wrappers.inc b/Moodle/mod/print/xmlrpc_wrappers.inc new file mode 100644 index 0000000..cb0c6e8 --- /dev/null +++ b/Moodle/mod/print/xmlrpc_wrappers.inc @@ -0,0 +1,944 @@ +' . $funcname[1]; + } + $exists = method_exists($funcname[0], $funcname[1]); + } + else + { + $plainfuncname = $funcname; + $exists = function_exists($funcname); + } + + if(!$exists) + { + error_log('XML-RPC: function to be wrapped is not defined: '.$plainfuncname); + return false; + } + else + { + // determine name of new php function + if($newfuncname == '') + { + if(is_array($funcname)) + { + if(is_string($funcname[0])) + $xmlrpcfuncname = "{$prefix}_".implode('_', $funcname); + else + $xmlrpcfuncname = "{$prefix}_".get_class($funcname[0]) . '_' . $funcname[1]; + } + else + { + $xmlrpcfuncname = "{$prefix}_$funcname"; + } + } + else + { + $xmlrpcfuncname = $newfuncname; + } + while($buildit && function_exists($xmlrpcfuncname)) + { + $xmlrpcfuncname .= 'x'; + } + + // start to introspect PHP code + if(is_array($funcname)) + { + $func =& new ReflectionMethod($funcname[0], $funcname[1]); + if($func->isPrivate()) + { + error_log('XML-RPC: method to be wrapped is private: '.$plainfuncname); + return false; + } + if($func->isProtected()) + { + error_log('XML-RPC: method to be wrapped is protected: '.$plainfuncname); + return false; + } + if($func->isConstructor()) + { + error_log('XML-RPC: method to be wrapped is the constructor: '.$plainfuncname); + return false; + } + if($func->isDestructor()) + { + error_log('XML-RPC: method to be wrapped is the destructor: '.$plainfuncname); + return false; + } + if($func->isAbstract()) + { + error_log('XML-RPC: method to be wrapped is abstract: '.$plainfuncname); + return false; + } + /// @todo add more checks for static vs. nonstatic? + } + else + { + $func =& new ReflectionFunction($funcname); + } + if($func->isInternal()) + { + // Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs + // instead of getparameters to fully reflect internal php functions ? + error_log('XML-RPC: function to be wrapped is internal: '.$plainfuncname); + return false; + } + + // retrieve parameter names, types and description from javadoc comments + + // function description + $desc = ''; + // type of return val: by default 'any' + $returns = $GLOBALS['xmlrpcValue']; + // desc of return val + $returnsDocs = ''; + // type + name of function parameters + $paramDocs = array(); + + $docs = $func->getDocComment(); + if($docs != '') + { + $docs = explode("\n", $docs); + $i = 0; + foreach($docs as $doc) + { + $doc = trim($doc, " \r\t/*"); + if(strlen($doc) && strpos($doc, '@') !== 0 && !$i) + { + if($desc) + { + $desc .= "\n"; + } + $desc .= $doc; + } + elseif(strpos($doc, '@param') === 0) + { + // syntax: @param type [$name] desc + if(preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches)) + { + if(strpos($matches[1], '|')) + { + //$paramDocs[$i]['type'] = explode('|', $matches[1]); + $paramDocs[$i]['type'] = 'mixed'; + } + else + { + $paramDocs[$i]['type'] = $matches[1]; + } + $paramDocs[$i]['name'] = trim($matches[2]); + $paramDocs[$i]['doc'] = $matches[3]; + } + $i++; + } + elseif(strpos($doc, '@return') === 0) + { + // syntax: @return type desc + //$returns = preg_split('/\s+/', $doc); + if(preg_match('/@return\s+(\S+)\s+(.+)/', $doc, $matches)) + { + $returns = php_2_xmlrpc_type($matches[1]); + if(isset($matches[2])) + { + $returnsDocs = $matches[2]; + } + } + } + } + } + + // execute introspection of actual function prototype + $params = array(); + $i = 0; + foreach($func->getParameters() as $paramobj) + { + $params[$i] = array(); + $params[$i]['name'] = '$'.$paramobj->getName(); + $params[$i]['isoptional'] = $paramobj->isOptional(); + $i++; + } + + + // start building of PHP code to be eval'd + $innercode = ''; + $i = 0; + $parsvariations = array(); + $pars = array(); + $pnum = count($params); + foreach($params as $param) + { + if (isset($paramDocs[$i]['name']) && $paramDocs[$i]['name'] && strtolower($paramDocs[$i]['name']) != strtolower($param['name'])) + { + // param name from phpdoc info does not match param definition! + $paramDocs[$i]['type'] = 'mixed'; + } + + if($param['isoptional']) + { + // this particular parameter is optional. save as valid previous list of parameters + $innercode .= "if (\$paramcount > $i) {\n"; + $parsvariations[] = $pars; + } + $innercode .= "\$p$i = \$msg->getParam($i);\n"; + if ($decode_php_objects) + { + $innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i, array('decode_php_objs'));\n"; + } + else + { + $innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i);\n"; + } + + $pars[] = "\$p$i"; + $i++; + if($param['isoptional']) + { + $innercode .= "}\n"; + } + if($i == $pnum) + { + // last allowed parameters combination + $parsvariations[] = $pars; + } + } + + $sigs = array(); + $psigs = array(); + if(count($parsvariations) == 0) + { + // only known good synopsis = no parameters + $parsvariations[] = array(); + $minpars = 0; + } + else + { + $minpars = count($parsvariations[0]); + } + + if($minpars) + { + // add to code the check for min params number + // NB: this check needs to be done BEFORE decoding param values + $innercode = "\$paramcount = \$msg->getNumParams();\n" . + "if (\$paramcount < $minpars) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}');\n" . $innercode; + } + else + { + $innercode = "\$paramcount = \$msg->getNumParams();\n" . $innercode; + } + + $innercode .= "\$np = false;\n"; + // since there are no closures in php, if we are given an object instance, + // we store a pointer to it in a global var... + if ( is_array($funcname) && is_object($funcname[0]) ) + { + $GLOBALS['xmlrpcWPFObjHolder'][$xmlrpcfuncname] =& $funcname[0]; + $innercode .= "\$obj =& \$GLOBALS['xmlrpcWPFObjHolder']['$xmlrpcfuncname'];\n"; + $realfuncname = '$obj->'.$funcname[1]; + } + else + { + $realfuncname = $plainfuncname; + } + foreach($parsvariations as $pars) + { + $innercode .= "if (\$paramcount == " . count($pars) . ") \$retval = {$catch_warnings}$realfuncname(" . implode(',', $pars) . "); else\n"; + // build a 'generic' signature (only use an appropriate return type) + $sig = array($returns); + $psig = array($returnsDocs); + for($i=0; $i < count($pars); $i++) + { + if (isset($paramDocs[$i]['type'])) + { + $sig[] = php_2_xmlrpc_type($paramDocs[$i]['type']); + } + else + { + $sig[] = $GLOBALS['xmlrpcValue']; + } + $psig[] = isset($paramDocs[$i]['doc']) ? $paramDocs[$i]['doc'] : ''; + } + $sigs[] = $sig; + $psigs[] = $psig; + } + $innercode .= "\$np = true;\n"; + $innercode .= "if (\$np) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}'); else {\n"; + //$innercode .= "if (\$_xmlrpcs_error_occurred) return new xmlrpcresp(0, $GLOBALS['xmlrpcerr']user, \$_xmlrpcs_error_occurred); else\n"; + $innercode .= "if (is_a(\$retval, '{$prefix}resp')) return \$retval; else\n"; + if($returns == $GLOBALS['xmlrpcDateTime'] || $returns == $GLOBALS['xmlrpcBase64']) + { + $innercode .= "return new {$prefix}resp(new {$prefix}val(\$retval, '$returns'));"; + } + else + { + if ($encode_php_objects) + $innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval, array('encode_php_objs')));\n"; + else + $innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval));\n"; + } + // shall we exclude functions returning by ref? + // if($func->returnsReference()) + // return false; + $code = "function $xmlrpcfuncname(\$msg) {\n" . $innercode . "}\n}"; + //print_r($code); + if ($buildit) + { + $allOK = 0; + eval($code.'$allOK=1;'); + // alternative + //$xmlrpcfuncname = create_function('$m', $innercode); + + if(!$allOK) + { + error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap php function '.$plainfuncname); + return false; + } + } + + /// @todo examine if $paramDocs matches $parsvariations and build array for + /// usage as method signature, plus put together a nice string for docs + + $ret = array('function' => $xmlrpcfuncname, 'signature' => $sigs, 'docstring' => $desc, 'signature_docs' => $psigs, 'source' => $code); + return $ret; + } + } + + /** + * Given a user-defined PHP class or php object, map its methods onto a list of + * PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc_server + * object and called from remote clients (as well as their corresponding signature info). + * + * @param mixed $classname the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class + * @param array $extra_options see the docs for wrap_php_method for more options + * string method_type 'static', 'nonstatic', 'all' and 'auto' (default); the latter will switch between static and non-static depending on wheter $classname is a class name or object instance + * @return array or false on failure + * + * @todo get_class_methods will return both static and non-static methods. + * we have to differentiate the action, depending on wheter we recived a class name or object + */ + function wrap_php_class($classname, $extra_options=array()) + { + $methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : ''; + $methodtype = isset($extra_options['method_type']) ? $extra_options['method_type'] : 'auto'; + + if(version_compare(phpversion(), '5.0.3') == -1) + { + // up to php 5.0.3 some useful reflection methods were missing + error_log('XML-RPC: cannot not wrap php functions unless running php version bigger than 5.0.3'); + return false; + } + + $result = array(); + $mlist = get_class_methods($classname); + foreach($mlist as $mname) + { + if ($methodfilter == '' || preg_match($methodfilter, $mname)) + { + // echo $mlist."\n"; + $func =& new ReflectionMethod($classname, $mname); + if(!$func->isPrivate() && !$func->isProtected() && !$func->isConstructor() && !$func->isDestructor() && !$func->isAbstract()) + { + if(($func->isStatic && ($methodtype == 'all' || $methodtype == 'static' || ($methodtype == 'auto' && is_string($classname)))) || + (!$func->isStatic && ($methodtype == 'all' || $methodtype == 'nonstatic' || ($methodtype == 'auto' && is_object($classname))))) + { + $methodwrap = wrap_php_function(array($classname, $mname), '', $extra_options); + if ( $methodwrap ) + { + $result[$methodwrap['function']] = $methodwrap['function']; + } + } + } + } + } + return $result; + } + + /** + * Given an xmlrpc client and a method name, register a php wrapper function + * that will call it and return results using native php types for both + * params and results. The generated php function will return an xmlrpcresp + * oject for failed xmlrpc calls + * + * Known limitations: + * - server must support system.methodsignature for the wanted xmlrpc method + * - for methods that expose many signatures, only one can be picked (we + * could in priciple check if signatures differ only by number of params + * and not by type, but it would be more complication than we can spare time) + * - nested xmlrpc params: the caller of the generated php function has to + * encode on its own the params passed to the php function if these are structs + * or arrays whose (sub)members include values of type datetime or base64 + * + * Notes: the connection properties of the given client will be copied + * and reused for the connection used during the call to the generated + * php function. + * Calling the generated php function 'might' be slow: a new xmlrpc client + * is created on every invocation and an xmlrpc-connection opened+closed. + * An extra 'debug' param is appended to param list of xmlrpc method, useful + * for debugging purposes. + * + * @param xmlrpc_client $client an xmlrpc client set up correctly to communicate with target server + * @param string $methodname the xmlrpc method to be mapped to a php function + * @param array $extra_options array of options that specify conversion details. valid ptions include + * integer signum the index of the method signature to use in mapping (if method exposes many sigs) + * integer timeout timeout (in secs) to be used when executing function/calling remote method + * string protocol 'http' (default), 'http11' or 'https' + * string new_function_name the name of php function to create. If unsepcified, lib will pick an appropriate name + * string return_source if true return php code w. function definition instead fo function name + * bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects + * bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers --- + * mixed return_on_fault a php value to be returned when the xmlrpc call fails/returns a fault response (by default the xmlrpcresp object is returned in this case). If a string is used, '%faultCode%' and '%faultString%' tokens will be substituted with actual error values + * bool debug set it to 1 or 2 to see debug results of querying server for method synopsis + * @return string the name of the generated php function (or false) - OR AN ARRAY... + */ + function wrap_xmlrpc_method($client, $methodname, $extra_options=0, $timeout=0, $protocol='', $newfuncname='') + { + // mind numbing: let caller use sane calling convention (as per javadoc, 3 params), + // OR the 2.0 calling convention (no options) - we really love backward compat, don't we? + if (!is_array($extra_options)) + { + $signum = $extra_options; + $extra_options = array(); + } + else + { + $signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0; + $timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0; + $protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : ''; + $newfuncname = isset($extra_options['new_function_name']) ? $extra_options['new_function_name'] : ''; + } + //$encode_php_objects = in_array('encode_php_objects', $extra_options); + //$verbatim_client_copy = in_array('simple_client_copy', $extra_options) ? 1 : + // in_array('build_class_code', $extra_options) ? 2 : 0; + + $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false; + $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false; + $simple_client_copy = isset($extra_options['simple_client_copy']) ? (int)($extra_options['simple_client_copy']) : 0; + $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true; + $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc'; + if (isset($extra_options['return_on_fault'])) + { + $decode_fault = true; + $fault_response = $extra_options['return_on_fault']; + } + else + { + $decode_fault = false; + $fault_response = ''; + } + $debug = isset($extra_options['debug']) ? ($extra_options['debug']) : 0; + + $msgclass = $prefix.'msg'; + $valclass = $prefix.'val'; + $decodefunc = 'php_'.$prefix.'_decode'; + + $msg =& new $msgclass('system.methodSignature'); + $msg->addparam(new $valclass($methodname)); + $client->setDebug($debug); + $response =& $client->send($msg, $timeout, $protocol); + if($response->faultCode()) + { + error_log('XML-RPC: could not retrieve method signature from remote server for method '.$methodname); + return false; + } + else + { + $msig = $response->value(); + if ($client->return_type != 'phpvals') + { + $msig = $decodefunc($msig); + } + if(!is_array($msig) || count($msig) <= $signum) + { + error_log('XML-RPC: could not retrieve method signature nr.'.$signum.' from remote server for method '.$methodname); + return false; + } + else + { + // pick a suitable name for the new function, avoiding collisions + if($newfuncname != '') + { + $xmlrpcfuncname = $newfuncname; + } + else + { + // take care to insure that methodname is translated to valid + // php function name + $xmlrpcfuncname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'), + array('_', ''), $methodname); + } + while($buildit && function_exists($xmlrpcfuncname)) + { + $xmlrpcfuncname .= 'x'; + } + + $msig = $msig[$signum]; + $mdesc = ''; + // if in 'offline' mode, get method description too. + // in online mode, favour speed of operation + if(!$buildit) + { + $msg =& new $msgclass('system.methodHelp'); + $msg->addparam(new $valclass($methodname)); + $response =& $client->send($msg, $timeout, $protocol); + if (!$response->faultCode()) + { + $mdesc = $response->value(); + if ($client->return_type != 'phpvals') + { + $mdesc = $mdesc->scalarval(); + } + } + } + + $results = build_remote_method_wrapper_code($client, $methodname, + $xmlrpcfuncname, $msig, $mdesc, $timeout, $protocol, $simple_client_copy, + $prefix, $decode_php_objects, $encode_php_objects, $decode_fault, + $fault_response); + + //print_r($code); + if ($buildit) + { + $allOK = 0; + eval($results['source'].'$allOK=1;'); + // alternative + //$xmlrpcfuncname = create_function('$m', $innercode); + if($allOK) + { + return $xmlrpcfuncname; + } + else + { + error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap remote method '.$methodname); + return false; + } + } + else + { + $results['function'] = $xmlrpcfuncname; + return $results; + } + } + } + } + + /** + * Similar to wrap_xmlrpc_method, but will generate a php class that wraps + * all xmlrpc methods exposed by the remote server as own methods. + * For more details see wrap_xmlrpc_method. + * @param xmlrpc_client $client the client obj all set to query the desired server + * @param array $extra_options list of options for wrapped code + * @return mixed false on error, the name of the created class if all ok or an array with code, class name and comments (if the appropriatevoption is set in extra_options) + */ + function wrap_xmlrpc_server($client, $extra_options=array()) + { + $methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : ''; + //$signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0; + $timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0; + $protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : ''; + $newclassname = isset($extra_options['new_class_name']) ? $extra_options['new_class_name'] : ''; + $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false; + $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false; + $verbatim_client_copy = isset($extra_options['simple_client_copy']) ? !($extra_options['simple_client_copy']) : true; + $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true; + $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc'; + + $msgclass = $prefix.'msg'; + //$valclass = $prefix.'val'; + $decodefunc = 'php_'.$prefix.'_decode'; + + $msg =& new $msgclass('system.listMethods'); + $response =& $client->send($msg, $timeout, $protocol); + if($response->faultCode()) + { + error_log('XML-RPC: could not retrieve method list from remote server'); + return false; + } + else + { + $mlist = $response->value(); + if ($client->return_type != 'phpvals') + { + $mlist = $decodefunc($mlist); + } + if(!is_array($mlist) || !count($mlist)) + { + error_log('XML-RPC: could not retrieve meaningful method list from remote server'); + return false; + } + else + { + // pick a suitable name for the new function, avoiding collisions + if($newclassname != '') + { + $xmlrpcclassname = $newclassname; + } + else + { + $xmlrpcclassname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'), + array('_', ''), $client->server).'_client'; + } + while($buildit && class_exists($xmlrpcclassname)) + { + $xmlrpcclassname .= 'x'; + } + + /// @todo add function setdebug() to new class, to enable/disable debugging + $source = "class $xmlrpcclassname\n{\nvar \$client;\n\n"; + $source .= "function $xmlrpcclassname()\n{\n"; + $source .= build_client_wrapper_code($client, $verbatim_client_copy, $prefix); + $source .= "\$this->client =& \$client;\n}\n\n"; + $opts = array('simple_client_copy' => 2, 'return_source' => true, + 'timeout' => $timeout, 'protocol' => $protocol, + 'encode_php_objs' => $encode_php_objects, 'prefix' => $prefix, + 'decode_php_objs' => $decode_php_objects + ); + /// @todo build javadoc for class definition, too + foreach($mlist as $mname) + { + if ($methodfilter == '' || preg_match($methodfilter, $mname)) + { + $opts['new_function_name'] = preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'), + array('_', ''), $mname); + $methodwrap = wrap_xmlrpc_method($client, $mname, $opts); + if ($methodwrap) + { + if (!$buildit) + { + $source .= $methodwrap['docstring']; + } + $source .= $methodwrap['source']."\n"; + } + else + { + error_log('XML-RPC: will not create class method to wrap remote method '.$mname); + } + } + } + $source .= "}\n"; + if ($buildit) + { + $allOK = 0; + eval($source.'$allOK=1;'); + // alternative + //$xmlrpcfuncname = create_function('$m', $innercode); + if($allOK) + { + return $xmlrpcclassname; + } + else + { + error_log('XML-RPC: could not create class '.$xmlrpcclassname.' to wrap remote server '.$client->server); + return false; + } + } + else + { + return array('class' => $xmlrpcclassname, 'code' => $source, 'docstring' => ''); + } + } + } + } + + /** + * Given the necessary info, build php code that creates a new function to + * invoke a remote xmlrpc method. + * Take care that no full checking of input parameters is done to ensure that + * valid php code is emitted. + * Note: real spaghetti code follows... + * @access private + */ + function build_remote_method_wrapper_code($client, $methodname, $xmlrpcfuncname, + $msig, $mdesc='', $timeout=0, $protocol='', $client_copy_mode=0, $prefix='xmlrpc', + $decode_php_objects=false, $encode_php_objects=false, $decode_fault=false, + $fault_response='') + { + $code = "function $xmlrpcfuncname ("; + if ($client_copy_mode < 2) + { + // client copy mode 0 or 1 == partial / full client copy in emitted code + $innercode = build_client_wrapper_code($client, $client_copy_mode, $prefix); + $innercode .= "\$client->setDebug(\$debug);\n"; + $this_ = ''; + } + else + { + // client copy mode 2 == no client copy in emitted code + $innercode = ''; + $this_ = 'this->'; + } + $innercode .= "\$msg =& new {$prefix}msg('$methodname');\n"; + + if ($mdesc != '') + { + // take care that PHP comment is not terminated unwillingly by method description + $mdesc = "/**\n* ".str_replace('*/', '* /', $mdesc)."\n"; + } + else + { + $mdesc = "/**\nFunction $xmlrpcfuncname\n"; + } + + // param parsing + $plist = array(); + $pcount = count($msig); + for($i = 1; $i < $pcount; $i++) + { + $plist[] = "\$p$i"; + $ptype = $msig[$i]; + if($ptype == 'i4' || $ptype == 'int' || $ptype == 'boolean' || $ptype == 'double' || + $ptype == 'string' || $ptype == 'dateTime.iso8601' || $ptype == 'base64' || $ptype == 'null') + { + // only build directly xmlrpcvals when type is known and scalar + $innercode .= "\$p$i =& new {$prefix}val(\$p$i, '$ptype');\n"; + } + else + { + if ($encode_php_objects) + { + $innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i, array('encode_php_objs'));\n"; + } + else + { + $innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i);\n"; + } + } + $innercode .= "\$msg->addparam(\$p$i);\n"; + $mdesc .= '* @param '.xmlrpc_2_php_type($ptype)." \$p$i\n"; + } + if ($client_copy_mode < 2) + { + $plist[] = '$debug=0'; + $mdesc .= "* @param int \$debug when 1 (or 2) will enable debugging of the underlying {$prefix} call (defaults to 0)\n"; + } + $plist = implode(', ', $plist); + $mdesc .= '* @return '.xmlrpc_2_php_type($msig[0])." (or an {$prefix}resp obj instance if call fails)\n*/\n"; + + $innercode .= "\$res =& \${$this_}client->send(\$msg, $timeout, '$protocol');\n"; + if ($decode_fault) + { + if (is_string($fault_response) && ((strpos($fault_response, '%faultCode%') !== false) || (strpos($fault_response, '%faultString%') !== false))) + { + $respcode = "str_replace(array('%faultCode%', '%faultString%'), array(\$res->faultCode(), \$res->faultString()), '".str_replace("'", "''", $fault_response)."')"; + } + else + { + $respcode = var_export($fault_response, true); + } + } + else + { + $respcode = '$res'; + } + if ($decode_php_objects) + { + $innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value(), array('decode_php_objs'));"; + } + else + { + $innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value());"; + } + + $code = $code . $plist. ") {\n" . $innercode . "\n}\n"; + + return array('source' => $code, 'docstring' => $mdesc); + } + + /** + * Given necessary info, generate php code that will rebuild a client object + * Take care that no full checking of input parameters is done to ensure that + * valid php code is emitted. + * @access private + */ + function build_client_wrapper_code($client, $verbatim_client_copy, $prefix='xmlrpc') + { + $code = "\$client =& new {$prefix}_client('".str_replace("'", "\'", $client->path). + "', '" . str_replace("'", "\'", $client->server) . "', $client->port);\n"; + + // copy all client fields to the client that will be generated runtime + // (this provides for future expansion or subclassing of client obj) + if ($verbatim_client_copy) + { + foreach($client as $fld => $val) + { + if($fld != 'debug' && $fld != 'return_type') + { + $val = var_export($val, true); + $code .= "\$client->$fld = $val;\n"; + } + } + } + // only make sure that client always returns the correct data type + $code .= "\$client->return_type = '{$prefix}vals';\n"; + //$code .= "\$client->setDebug(\$debug);\n"; + return $code; + } +?> \ No newline at end of file diff --git a/Moodle/mod/print/xmlrpcs.inc b/Moodle/mod/print/xmlrpcs.inc new file mode 100644 index 0000000..a089ca5 --- /dev/null +++ b/Moodle/mod/print/xmlrpcs.inc @@ -0,0 +1,1198 @@ + +// $Id: xmlrpcs.inc,v 1.71 2008/10/29 23:41:28 ggiunta Exp $ + +// Copyright (c) 1999,2000,2002 Edd Dumbill. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions +// are met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following +// disclaimer in the documentation and/or other materials provided +// with the distribution. +// +// * Neither the name of the "XML-RPC for PHP" nor the names of its +// contributors may be used to endorse or promote products derived +// from this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +// REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. + + // XML RPC Server class + // requires: xmlrpc.inc + + $GLOBALS['xmlrpcs_capabilities'] = array( + // xmlrpc spec: always supported + 'xmlrpc' => new xmlrpcval(array( + 'specUrl' => new xmlrpcval('http://www.xmlrpc.com/spec', 'string'), + 'specVersion' => new xmlrpcval(1, 'int') + ), 'struct'), + // if we support system.xxx functions, we always support multicall, too... + // Note that, as of 2006/09/17, the following URL does not respond anymore + 'system.multicall' => new xmlrpcval(array( + 'specUrl' => new xmlrpcval('http://www.xmlrpc.com/discuss/msgReader$1208', 'string'), + 'specVersion' => new xmlrpcval(1, 'int') + ), 'struct'), + // introspection: version 2! we support 'mixed', too + 'introspection' => new xmlrpcval(array( + 'specUrl' => new xmlrpcval('http://phpxmlrpc.sourceforge.net/doc-2/ch10.html', 'string'), + 'specVersion' => new xmlrpcval(2, 'int') + ), 'struct') + ); + + /* Functions that implement system.XXX methods of xmlrpc servers */ + $_xmlrpcs_getCapabilities_sig=array(array($GLOBALS['xmlrpcStruct'])); + $_xmlrpcs_getCapabilities_doc='This method lists all the capabilites that the XML-RPC server has: the (more or less standard) extensions to the xmlrpc spec that it adheres to'; + $_xmlrpcs_getCapabilities_sdoc=array(array('list of capabilities, described as structs with a version number and url for the spec')); + function _xmlrpcs_getCapabilities($server, $m=null) + { + $outAr = $GLOBALS['xmlrpcs_capabilities']; + // NIL extension + if ($GLOBALS['xmlrpc_null_extension']) { + $outAr['nil'] = new xmlrpcval(array( + 'specUrl' => new xmlrpcval('http://www.ontosys.com/xml-rpc/extensions.php', 'string'), + 'specVersion' => new xmlrpcval(1, 'int') + ), 'struct'); + } + return new xmlrpcresp(new xmlrpcval($outAr, 'struct')); + } + + // listMethods: signature was either a string, or nothing. + // The useless string variant has been removed + $_xmlrpcs_listMethods_sig=array(array($GLOBALS['xmlrpcArray'])); + $_xmlrpcs_listMethods_doc='This method lists all the methods that the XML-RPC server knows how to dispatch'; + $_xmlrpcs_listMethods_sdoc=array(array('list of method names')); + function _xmlrpcs_listMethods($server, $m=null) // if called in plain php values mode, second param is missing + { + + $outAr=array(); + foreach($server->dmap as $key => $val) + { + $outAr[]=&new xmlrpcval($key, 'string'); + } + if($server->allow_system_funcs) + { + foreach($GLOBALS['_xmlrpcs_dmap'] as $key => $val) + { + $outAr[]=&new xmlrpcval($key, 'string'); + } + } + return new xmlrpcresp(new xmlrpcval($outAr, 'array')); + } + + $_xmlrpcs_methodSignature_sig=array(array($GLOBALS['xmlrpcArray'], $GLOBALS['xmlrpcString'])); + $_xmlrpcs_methodSignature_doc='Returns an array of known signatures (an array of arrays) for the method name passed. If no signatures are known, returns a none-array (test for type != array to detect missing signature)'; + $_xmlrpcs_methodSignature_sdoc=array(array('list of known signatures, each sig being an array of xmlrpc type names', 'name of method to be described')); + function _xmlrpcs_methodSignature($server, $m) + { + // let accept as parameter both an xmlrpcval or string + if (is_object($m)) + { + $methName=$m->getParam(0); + $methName=$methName->scalarval(); + } + else + { + $methName=$m; + } + if(strpos($methName, "system.") === 0) + { + $dmap=$GLOBALS['_xmlrpcs_dmap']; $sysCall=1; + } + else + { + $dmap=$server->dmap; $sysCall=0; + } + if(isset($dmap[$methName])) + { + if(isset($dmap[$methName]['signature'])) + { + $sigs=array(); + foreach($dmap[$methName]['signature'] as $inSig) + { + $cursig=array(); + foreach($inSig as $sig) + { + $cursig[]=&new xmlrpcval($sig, 'string'); + } + $sigs[]=&new xmlrpcval($cursig, 'array'); + } + $r=&new xmlrpcresp(new xmlrpcval($sigs, 'array')); + } + else + { + // NB: according to the official docs, we should be returning a + // "none-array" here, which means not-an-array + $r=&new xmlrpcresp(new xmlrpcval('undef', 'string')); + } + } + else + { + $r=&new xmlrpcresp(0,$GLOBALS['xmlrpcerr']['introspect_unknown'], $GLOBALS['xmlrpcstr']['introspect_unknown']); + } + return $r; + } + + $_xmlrpcs_methodHelp_sig=array(array($GLOBALS['xmlrpcString'], $GLOBALS['xmlrpcString'])); + $_xmlrpcs_methodHelp_doc='Returns help text if defined for the method passed, otherwise returns an empty string'; + $_xmlrpcs_methodHelp_sdoc=array(array('method description', 'name of the method to be described')); + function _xmlrpcs_methodHelp($server, $m) + { + // let accept as parameter both an xmlrpcval or string + if (is_object($m)) + { + $methName=$m->getParam(0); + $methName=$methName->scalarval(); + } + else + { + $methName=$m; + } + if(strpos($methName, "system.") === 0) + { + $dmap=$GLOBALS['_xmlrpcs_dmap']; $sysCall=1; + } + else + { + $dmap=$server->dmap; $sysCall=0; + } + if(isset($dmap[$methName])) + { + if(isset($dmap[$methName]['docstring'])) + { + $r=&new xmlrpcresp(new xmlrpcval($dmap[$methName]['docstring']), 'string'); + } + else + { + $r=&new xmlrpcresp(new xmlrpcval('', 'string')); + } + } + else + { + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['introspect_unknown'], $GLOBALS['xmlrpcstr']['introspect_unknown']); + } + return $r; + } + + $_xmlrpcs_multicall_sig = array(array($GLOBALS['xmlrpcArray'], $GLOBALS['xmlrpcArray'])); + $_xmlrpcs_multicall_doc = 'Boxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details'; + $_xmlrpcs_multicall_sdoc = array(array('list of response structs, where each struct has the usual members', 'list of calls, with each call being represented as a struct, with members "methodname" and "params"')); + function _xmlrpcs_multicall_error($err) + { + if(is_string($err)) + { + $str = $GLOBALS['xmlrpcstr']["multicall_${err}"]; + $code = $GLOBALS['xmlrpcerr']["multicall_${err}"]; + } + else + { + $code = $err->faultCode(); + $str = $err->faultString(); + } + $struct = array(); + $struct['faultCode'] =& new xmlrpcval($code, 'int'); + $struct['faultString'] =& new xmlrpcval($str, 'string'); + return new xmlrpcval($struct, 'struct'); + } + + function _xmlrpcs_multicall_do_call($server, $call) + { + if($call->kindOf() != 'struct') + { + return _xmlrpcs_multicall_error('notstruct'); + } + $methName = @$call->structmem('methodName'); + if(!$methName) + { + return _xmlrpcs_multicall_error('nomethod'); + } + if($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string') + { + return _xmlrpcs_multicall_error('notstring'); + } + if($methName->scalarval() == 'system.multicall') + { + return _xmlrpcs_multicall_error('recursion'); + } + + $params = @$call->structmem('params'); + if(!$params) + { + return _xmlrpcs_multicall_error('noparams'); + } + if($params->kindOf() != 'array') + { + return _xmlrpcs_multicall_error('notarray'); + } + $numParams = $params->arraysize(); + + $msg =& new xmlrpcmsg($methName->scalarval()); + for($i = 0; $i < $numParams; $i++) + { + if(!$msg->addParam($params->arraymem($i))) + { + $i++; + return _xmlrpcs_multicall_error(new xmlrpcresp(0, + $GLOBALS['xmlrpcerr']['incorrect_params'], + $GLOBALS['xmlrpcstr']['incorrect_params'] . ": probable xml error in param " . $i)); + } + } + + $result = $server->execute($msg); + + if($result->faultCode() != 0) + { + return _xmlrpcs_multicall_error($result); // Method returned fault. + } + + return new xmlrpcval(array($result->value()), 'array'); + } + + function _xmlrpcs_multicall_do_call_phpvals($server, $call) + { + if(!is_array($call)) + { + return _xmlrpcs_multicall_error('notstruct'); + } + if(!array_key_exists('methodName', $call)) + { + return _xmlrpcs_multicall_error('nomethod'); + } + if (!is_string($call['methodName'])) + { + return _xmlrpcs_multicall_error('notstring'); + } + if($call['methodName'] == 'system.multicall') + { + return _xmlrpcs_multicall_error('recursion'); + } + if(!array_key_exists('params', $call)) + { + return _xmlrpcs_multicall_error('noparams'); + } + if(!is_array($call['params'])) + { + return _xmlrpcs_multicall_error('notarray'); + } + + // this is a real dirty and simplistic hack, since we might have received a + // base64 or datetime values, but they will be listed as strings here... + $numParams = count($call['params']); + $pt = array(); + foreach($call['params'] as $val) + $pt[] = php_2_xmlrpc_type(gettype($val)); + + $result = $server->execute($call['methodName'], $call['params'], $pt); + + if($result->faultCode() != 0) + { + return _xmlrpcs_multicall_error($result); // Method returned fault. + } + + return new xmlrpcval(array($result->value()), 'array'); + } + + function _xmlrpcs_multicall($server, $m) + { + $result = array(); + // let accept a plain list of php parameters, beside a single xmlrpc msg object + if (is_object($m)) + { + $calls = $m->getParam(0); + $numCalls = $calls->arraysize(); + for($i = 0; $i < $numCalls; $i++) + { + $call = $calls->arraymem($i); + $result[$i] = _xmlrpcs_multicall_do_call($server, $call); + } + } + else + { + $numCalls=count($m); + for($i = 0; $i < $numCalls; $i++) + { + $result[$i] = _xmlrpcs_multicall_do_call_phpvals($server, $m[$i]); + } + } + + return new xmlrpcresp(new xmlrpcval($result, 'array')); + } + + $GLOBALS['_xmlrpcs_dmap']=array( + 'system.listMethods' => array( + 'function' => '_xmlrpcs_listMethods', + 'signature' => $_xmlrpcs_listMethods_sig, + 'docstring' => $_xmlrpcs_listMethods_doc, + 'signature_docs' => $_xmlrpcs_listMethods_sdoc), + 'system.methodHelp' => array( + 'function' => '_xmlrpcs_methodHelp', + 'signature' => $_xmlrpcs_methodHelp_sig, + 'docstring' => $_xmlrpcs_methodHelp_doc, + 'signature_docs' => $_xmlrpcs_methodHelp_sdoc), + 'system.methodSignature' => array( + 'function' => '_xmlrpcs_methodSignature', + 'signature' => $_xmlrpcs_methodSignature_sig, + 'docstring' => $_xmlrpcs_methodSignature_doc, + 'signature_docs' => $_xmlrpcs_methodSignature_sdoc), + 'system.multicall' => array( + 'function' => '_xmlrpcs_multicall', + 'signature' => $_xmlrpcs_multicall_sig, + 'docstring' => $_xmlrpcs_multicall_doc, + 'signature_docs' => $_xmlrpcs_multicall_sdoc), + 'system.getCapabilities' => array( + 'function' => '_xmlrpcs_getCapabilities', + 'signature' => $_xmlrpcs_getCapabilities_sig, + 'docstring' => $_xmlrpcs_getCapabilities_doc, + 'signature_docs' => $_xmlrpcs_getCapabilities_sdoc) + ); + + $GLOBALS['_xmlrpcs_occurred_errors'] = ''; + $GLOBALS['_xmlrpcs_prev_ehandler'] = ''; + /** + * Error handler used to track errors that occur during server-side execution of PHP code. + * This allows to report back to the client whether an internal error has occurred or not + * using an xmlrpc response object, instead of letting the client deal with the html junk + * that a PHP execution error on the server generally entails. + * + * NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors. + * + */ + function _xmlrpcs_errorHandler($errcode, $errstring, $filename=null, $lineno=null, $context=null) + { + // obey the @ protocol + if (error_reporting() == 0) + return; + + //if($errcode != E_NOTICE && $errcode != E_WARNING && $errcode != E_USER_NOTICE && $errcode != E_USER_WARNING) + if($errcode != 2048) // do not use E_STRICT by name, since on PHP 4 it will not be defined + { + $GLOBALS['_xmlrpcs_occurred_errors'] = $GLOBALS['_xmlrpcs_occurred_errors'] . $errstring . "\n"; + } + // Try to avoid as much as possible disruption to the previous error handling + // mechanism in place + if($GLOBALS['_xmlrpcs_prev_ehandler'] == '') + { + // The previous error handler was the default: all we should do is log error + // to the default error log (if level high enough) + if(ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errcode)) + { + error_log($errstring); + } + } + else + { + // Pass control on to previous error handler, trying to avoid loops... + if($GLOBALS['_xmlrpcs_prev_ehandler'] != '_xmlrpcs_errorHandler') + { + // NB: this code will NOT work on php < 4.0.2: only 2 params were used for error handlers + if(is_array($GLOBALS['_xmlrpcs_prev_ehandler'])) + { + // the following works both with static class methods and plain object methods as error handler + call_user_func_array($GLOBALS['_xmlrpcs_prev_ehandler'], array($errcode, $errstring, $filename, $lineno, $context)); + } + else + { + $GLOBALS['_xmlrpcs_prev_ehandler']($errcode, $errstring, $filename, $lineno, $context); + } + } + } + } + + $GLOBALS['_xmlrpc_debuginfo']=''; + + /** + * Add a string to the debug info that can be later seralized by the server + * as part of the response message. + * Note that for best compatbility, the debug string should be encoded using + * the $GLOBALS['xmlrpc_internalencoding'] character set. + * @param string $m + * @access public + */ + function xmlrpc_debugmsg($m) + { + $GLOBALS['_xmlrpc_debuginfo'] .= $m . "\n"; + } + + class xmlrpc_server + { + /// array defining php functions exposed as xmlrpc methods by this server + var $dmap=array(); + /** + * Defines how functions in dmap will be invokde: either using an xmlrpc msg object + * or plain php values. + * valid strings are 'xmlrpcvals', 'phpvals' or 'epivals' + */ + var $functions_parameters_type='xmlrpcvals'; + /// controls wether the server is going to echo debugging messages back to the client as comments in response body. valid values: 0,1,2,3 + var $debug = 1; + /** + * When set to true, it will enable HTTP compression of the response, in case + * the client has declared its support for compression in the request. + */ + var $compress_response = false; + /** + * List of http compression methods accepted by the server for requests. + * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib + */ + var $accepted_compression = array(); + /// shall we serve calls to system.* methods? + var $allow_system_funcs = true; + /// list of charset encodings natively accepted for requests + var $accepted_charset_encodings = array(); + /** + * charset encoding to be used for response. + * NB: if we can, we will convert the generated response from internal_encoding to the intended one. + * can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled), + * null (leave unspecified in response, convert output stream to US_ASCII), + * 'default' (use xmlrpc library default as specified in xmlrpc.inc, convert output stream if needed), + * or 'auto' (use client-specified charset encoding or same as request if request headers do not specify it (unless request is US-ASCII: then use library default anyway). + * NB: pretty dangerous if you accept every charset and do not have mbstring enabled) + */ + var $response_charset_encoding = ''; + /// storage for internal debug info + var $debug_info = ''; + /// extra data passed at runtime to method handling functions. Used only by EPI layer + var $user_data = null; + + /** + * @param array $dispmap the dispatch map withd efinition of exposed services + * @param boolean $servicenow set to false to prevent the server from runnung upon construction + */ + function xmlrpc_server($dispMap=null, $serviceNow=true) + { + // if ZLIB is enabled, let the server by default accept compressed requests, + // and compress responses sent to clients that support them + if(function_exists('gzinflate')) + { + $this->accepted_compression = array('gzip', 'deflate'); + $this->compress_response = true; + } + + // by default the xml parser can support these 3 charset encodings + $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII'); + + // dispMap is a dispatch array of methods + // mapped to function names and signatures + // if a method + // doesn't appear in the map then an unknown + // method error is generated + /* milosch - changed to make passing dispMap optional. + * instead, you can use the class add_to_map() function + * to add functions manually (borrowed from SOAPX4) + */ + if($dispMap) + { + $this->dmap = $dispMap; + if($serviceNow) + { + $this->service(); + } + } + } + + /** + * Set debug level of server. + * @param integer $in debug lvl: determines info added to xmlrpc responses (as xml comments) + * 0 = no debug info, + * 1 = msgs set from user with debugmsg(), + * 2 = add complete xmlrpc request (headers and body), + * 3 = add also all processing warnings happened during method processing + * (NB: this involves setting a custom error handler, and might interfere + * with the standard processing of the php function exposed as method. In + * particular, triggering an USER_ERROR level error will not halt script + * execution anymore, but just end up logged in the xmlrpc response) + * Note that info added at elevel 2 and 3 will be base64 encoded + * @access public + */ + function setDebug($in) + { + $this->debug=$in; + } + + /** + * Return a string with the serialized representation of all debug info + * @param string $charset_encoding the target charset encoding for the serialization + * @return string an XML comment (or two) + */ + function serializeDebug($charset_encoding='') + { + // Tough encoding problem: which internal charset should we assume for debug info? + // It might contain a copy of raw data received from client, ie with unknown encoding, + // intermixed with php generated data and user generated data... + // so we split it: system debug is base 64 encoded, + // user debug info should be encoded by the end user using the INTERNAL_ENCODING + $out = ''; + if ($this->debug_info != '') + { + $out .= "\n"; + } + if($GLOBALS['_xmlrpc_debuginfo']!='') + { + + $out .= "\n"; + // NB: a better solution MIGHT be to use CDATA, but we need to insert it + // into return payload AFTER the beginning tag + //$out .= "', ']_]_>', $GLOBALS['_xmlrpc_debuginfo']) . "\n]]>\n"; + } + return $out; + } + + /** + * Execute the xmlrpc request, printing the response + * @param string $data the request body. If null, the http POST request will be examined + * @return xmlrpcresp the response object (usually not used by caller...) + * @access public + */ + function service($data=null, $return_payload=false) + { + if ($data === null) + { + // workaround for a known bug in php ver. 5.2.2 that broke $HTTP_RAW_POST_DATA + $ver = phpversion(); + if ($ver[0] >= 5) + { + $data = file_get_contents('php://input'); + } + else + { + $data = isset($GLOBALS['HTTP_RAW_POST_DATA']) ? $GLOBALS['HTTP_RAW_POST_DATA'] : ''; + } + } + $raw_data = $data; + + // reset internal debug info + $this->debug_info = ''; + + // Echo back what we received, before parsing it + if($this->debug > 1) + { + $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++"); + } + + $r = $this->parseRequestHeaders($data, $req_charset, $resp_charset, $resp_encoding); + if (!$r) + { + $r=$this->parseRequest($data, $req_charset); + } + + // save full body of request into response, for more debugging usages + $r->raw_data = $raw_data; + + if($this->debug > 2 && $GLOBALS['_xmlrpcs_occurred_errors']) + { + $this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" . + $GLOBALS['_xmlrpcs_occurred_errors'] . "+++END+++"); + } + + $payload=$this->xml_header($resp_charset); + if($this->debug > 0) + { + $payload = $payload . $this->serializeDebug($resp_charset); + } + + // G. Giunta 2006-01-27: do not create response serialization if it has + // already happened. Helps building json magic + if (empty($r->payload)) + { + $r->serialize($resp_charset); + } + $payload = $payload . $r->payload; + + if ($return_payload) + { + return $payload; + } + + // if we get a warning/error that has output some text before here, then we cannot + // add a new header. We cannot say we are sending xml, either... + if(!headers_sent()) + { + header('Content-Type: '.$r->content_type); + // we do not know if client actually told us an accepted charset, but if he did + // we have to tell him what we did + header("Vary: Accept-Charset"); + + // http compression of output: only + // if we can do it, and we want to do it, and client asked us to, + // and php ini settings do not force it already + $php_no_self_compress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler'); + if($this->compress_response && function_exists('gzencode') && $resp_encoding != '' + && $php_no_self_compress) + { + if(strpos($resp_encoding, 'gzip') !== false) + { + $payload = gzencode($payload); + header("Content-Encoding: gzip"); + header("Vary: Accept-Encoding"); + } + elseif (strpos($resp_encoding, 'deflate') !== false) + { + $payload = gzcompress($payload); + header("Content-Encoding: deflate"); + header("Vary: Accept-Encoding"); + } + } + + // do not ouput content-length header if php is compressing output for us: + // it will mess up measurements + if($php_no_self_compress) + { + header('Content-Length: ' . (int)strlen($payload)); + } + } + else + { + error_log('XML-RPC: xmlrpc_server::service: http headers already sent before response is fully generated. Check for php warning or error messages'); + } + + print $payload; + + // return request, in case subclasses want it + return $r; + } + + /** + * Add a method to the dispatch map + * @param string $methodname the name with which the method will be made available + * @param string $function the php function that will get invoked + * @param array $sig the array of valid method signatures + * @param string $doc method documentation + * @param array $sigdoc the array of valid method signatures docs (one string per param, one for return type) + * @access public + */ + function add_to_map($methodname,$function,$sig=null,$doc=false,$sigdoc=false) + { + $this->dmap[$methodname] = array( + 'function' => $function, + 'docstring' => $doc + ); + if ($sig) + { + $this->dmap[$methodname]['signature'] = $sig; + } + if ($sigdoc) + { + $this->dmap[$methodname]['signature_docs'] = $sigdoc; + } + } + + /** + * Verify type and number of parameters received against a list of known signatures + * @param array $in array of either xmlrpcval objects or xmlrpc type definitions + * @param array $sig array of known signatures to match against + * @access private + */ + function verifySignature($in, $sig) + { + // check each possible signature in turn + if (is_object($in)) + { + $numParams = $in->getNumParams(); + } + else + { + $numParams = count($in); + } + foreach($sig as $cursig) + { + if(count($cursig)==$numParams+1) + { + $itsOK=1; + for($n=0; $n<$numParams; $n++) + { + if (is_object($in)) + { + $p=$in->getParam($n); + if($p->kindOf() == 'scalar') + { + $pt=$p->scalartyp(); + } + else + { + $pt=$p->kindOf(); + } + } + else + { + $pt= $in[$n] == 'i4' ? 'int' : $in[$n]; // dispatch maps never use i4... + } + + // param index is $n+1, as first member of sig is return type + if($pt != $cursig[$n+1] && $cursig[$n+1] != $GLOBALS['xmlrpcValue']) + { + $itsOK=0; + $pno=$n+1; + $wanted=$cursig[$n+1]; + $got=$pt; + break; + } + } + if($itsOK) + { + return array(1,''); + } + } + } + if(isset($wanted)) + { + return array(0, "Wanted ${wanted}, got ${got} at param ${pno}"); + } + else + { + return array(0, "No method signature matches number of parameters"); + } + } + + /** + * Parse http headers received along with xmlrpc request. If needed, inflate request + * @return null on success or an xmlrpcresp + * @access private + */ + function parseRequestHeaders(&$data, &$req_encoding, &$resp_encoding, &$resp_compression) + { + // Play nice to PHP 4.0.x: superglobals were not yet invented... + if(!isset($_SERVER)) + { + $_SERVER = $GLOBALS['HTTP_SERVER_VARS']; + } + + if($this->debug > 1) + { + if(function_exists('getallheaders')) + { + $this->debugmsg(''); // empty line + foreach(getallheaders() as $name => $val) + { + $this->debugmsg("HEADER: $name: $val"); + } + } + + } + + if(isset($_SERVER['HTTP_CONTENT_ENCODING'])) + { + $content_encoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']); + } + else + { + $content_encoding = ''; + } + + // check if request body has been compressed and decompress it + if($content_encoding != '' && strlen($data)) + { + if($content_encoding == 'deflate' || $content_encoding == 'gzip') + { + // if decoding works, use it. else assume data wasn't gzencoded + if(function_exists('gzinflate') && in_array($content_encoding, $this->accepted_compression)) + { + if($content_encoding == 'deflate' && $degzdata = @gzuncompress($data)) + { + $data = $degzdata; + if($this->debug > 1) + { + $this->debugmsg("\n+++INFLATED REQUEST+++[".strlen($data)." chars]+++\n" . $data . "\n+++END+++"); + } + } + elseif($content_encoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) + { + $data = $degzdata; + if($this->debug > 1) + $this->debugmsg("+++INFLATED REQUEST+++[".strlen($data)." chars]+++\n" . $data . "\n+++END+++"); + } + else + { + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['server_decompress_fail'], $GLOBALS['xmlrpcstr']['server_decompress_fail']); + return $r; + } + } + else + { + //error_log('The server sent deflated data. Your php install must have the Zlib extension compiled in to support this.'); + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['server_cannot_decompress'], $GLOBALS['xmlrpcstr']['server_cannot_decompress']); + return $r; + } + } + } + + // check if client specified accepted charsets, and if we know how to fulfill + // the request + if ($this->response_charset_encoding == 'auto') + { + $resp_encoding = ''; + if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) + { + // here we should check if we can match the client-requested encoding + // with the encodings we know we can generate. + /// @todo we should parse q=0.x preferences instead of getting first charset specified... + $client_accepted_charsets = explode(',', strtoupper($_SERVER['HTTP_ACCEPT_CHARSET'])); + // Give preference to internal encoding + $known_charsets = array($GLOBALS['xmlrpc_internalencoding'], 'UTF-8', 'ISO-8859-1', 'US-ASCII'); + foreach ($known_charsets as $charset) + { + foreach ($client_accepted_charsets as $accepted) + if (strpos($accepted, $charset) === 0) + { + $resp_encoding = $charset; + break; + } + if ($resp_encoding) + break; + } + } + } + else + { + $resp_encoding = $this->response_charset_encoding; + } + + if (isset($_SERVER['HTTP_ACCEPT_ENCODING'])) + { + $resp_compression = $_SERVER['HTTP_ACCEPT_ENCODING']; + } + else + { + $resp_compression = ''; + } + + // 'guestimate' request encoding + /// @todo check if mbstring is enabled and automagic input conversion is on: it might mingle with this check??? + $req_encoding = guess_encoding(isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '', + $data); + + return null; + } + + /** + * Parse an xml chunk containing an xmlrpc request and execute the corresponding + * php function registered with the server + * @param string $data the xml request + * @param string $req_encoding (optional) the charset encoding of the xml request + * @return xmlrpcresp + * @access private + */ + function parseRequest($data, $req_encoding='') + { + // 2005/05/07 commented and moved into caller function code + //if($data=='') + //{ + // $data=$GLOBALS['HTTP_RAW_POST_DATA']; + //} + + // G. Giunta 2005/02/13: we do NOT expect to receive html entities + // so we do not try to convert them into xml character entities + //$data = xmlrpc_html_entity_xlate($data); + + $GLOBALS['_xh']=array(); + $GLOBALS['_xh']['ac']=''; + $GLOBALS['_xh']['stack']=array(); + $GLOBALS['_xh']['valuestack'] = array(); + $GLOBALS['_xh']['params']=array(); + $GLOBALS['_xh']['pt']=array(); + $GLOBALS['_xh']['isf']=0; + $GLOBALS['_xh']['isf_reason']=''; + $GLOBALS['_xh']['method']=false; // so we can check later if we got a methodname or not + $GLOBALS['_xh']['rt']=''; + + // decompose incoming XML into request structure + if ($req_encoding != '') + { + if (!in_array($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) + // the following code might be better for mb_string enabled installs, but + // makes the lib about 200% slower... + //if (!is_valid_charset($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) + { + error_log('XML-RPC: xmlrpc_server::parseRequest: invalid charset encoding of received request: '.$req_encoding); + $req_encoding = $GLOBALS['xmlrpc_defencoding']; + } + /// @BUG this will fail on PHP 5 if charset is not specified in the xml prologue, + // the encoding is not UTF8 and there are non-ascii chars in the text... + /// @todo use an ampty string for php 5 ??? + $parser = xml_parser_create($req_encoding); + } + else + { + $parser = xml_parser_create(); + } + + xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true); + // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell + // the xml parser to give us back data in the expected charset + // What if internal encoding is not in one of the 3 allowed? + // we use the broadest one, ie. utf8 + // This allows to send data which is native in various charset, + // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding + if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) + { + xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8'); + } + else + { + xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']); + } + + if ($this->functions_parameters_type != 'xmlrpcvals') + xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast'); + else + xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee'); + xml_set_character_data_handler($parser, 'xmlrpc_cd'); + xml_set_default_handler($parser, 'xmlrpc_dh'); + if(!xml_parse($parser, $data, 1)) + { + // return XML error as a faultCode + $r=&new xmlrpcresp(0, + $GLOBALS['xmlrpcerrxml']+xml_get_error_code($parser), + sprintf('XML error: %s at line %d, column %d', + xml_error_string(xml_get_error_code($parser)), + xml_get_current_line_number($parser), xml_get_current_column_number($parser))); + xml_parser_free($parser); + } + elseif ($GLOBALS['_xh']['isf']) + { + xml_parser_free($parser); + $r=&new xmlrpcresp(0, + $GLOBALS['xmlrpcerr']['invalid_request'], + $GLOBALS['xmlrpcstr']['invalid_request'] . ' ' . $GLOBALS['_xh']['isf_reason']); + } + else + { + xml_parser_free($parser); + if ($this->functions_parameters_type != 'xmlrpcvals') + { + if($this->debug > 1) + { + $this->debugmsg("\n+++PARSED+++\n".var_export($GLOBALS['_xh']['params'], true)."\n+++END+++"); + } + $r = $this->execute($GLOBALS['_xh']['method'], $GLOBALS['_xh']['params'], $GLOBALS['_xh']['pt']); + } + else + { + // build an xmlrpcmsg object with data parsed from xml + $m=&new xmlrpcmsg($GLOBALS['_xh']['method']); + // now add parameters in + for($i=0; $iaddParam($GLOBALS['_xh']['params'][$i]); + } + + if($this->debug > 1) + { + $this->debugmsg("\n+++PARSED+++\n".var_export($m, true)."\n+++END+++"); + } + $r = $this->execute($m); + } + } + return $r; + } + + /** + * Execute a method invoked by the client, checking parameters used + * @param mixed $m either an xmlrpcmsg obj or a method name + * @param array $params array with method parameters as php types (if m is method name only) + * @param array $paramtypes array with xmlrpc types of method parameters (if m is method name only) + * @return xmlrpcresp + * @access private + */ + function execute($m, $params=null, $paramtypes=null) + { + if (is_object($m)) + { + $methName = $m->method(); + } + else + { + $methName = $m; + } + $sysCall = $this->allow_system_funcs && (strpos($methName, "system.") === 0); + $dmap = $sysCall ? $GLOBALS['_xmlrpcs_dmap'] : $this->dmap; + + if(!isset($dmap[$methName]['function'])) + { + // No such method + return new xmlrpcresp(0, + $GLOBALS['xmlrpcerr']['unknown_method'], + $GLOBALS['xmlrpcstr']['unknown_method']); + } + + // Check signature + if(isset($dmap[$methName]['signature'])) + { + $sig = $dmap[$methName]['signature']; + if (is_object($m)) + { + list($ok, $errstr) = $this->verifySignature($m, $sig); + } + else + { + list($ok, $errstr) = $this->verifySignature($paramtypes, $sig); + } + if(!$ok) + { + // Didn't match. + return new xmlrpcresp( + 0, + $GLOBALS['xmlrpcerr']['incorrect_params'], + $GLOBALS['xmlrpcstr']['incorrect_params'] . ": ${errstr}" + ); + } + } + + $func = $dmap[$methName]['function']; + // let the 'class::function' syntax be accepted in dispatch maps + if(is_string($func) && strpos($func, '::')) + { + $func = explode('::', $func); + } + // verify that function to be invoked is in fact callable + if(!is_callable($func)) + { + error_log("XML-RPC: xmlrpc_server::execute: function $func registered as method handler is not callable"); + return new xmlrpcresp( + 0, + $GLOBALS['xmlrpcerr']['server_error'], + $GLOBALS['xmlrpcstr']['server_error'] . ": no function matches method" + ); + } + + // If debug level is 3, we should catch all errors generated during + // processing of user function, and log them as part of response + if($this->debug > 2) + { + $GLOBALS['_xmlrpcs_prev_ehandler'] = set_error_handler('_xmlrpcs_errorHandler'); + } + if (is_object($m)) + { + if($sysCall) + { + $r = call_user_func($func, $this, $m); + } + else + { + $r = call_user_func($func, $m); + } + if (!is_a($r, 'xmlrpcresp')) + { + error_log("XML-RPC: xmlrpc_server::execute: function $func registered as method handler does not return an xmlrpcresp object"); + if (is_a($r, 'xmlrpcval')) + { + $r =& new xmlrpcresp($r); + } + else + { + $r =& new xmlrpcresp( + 0, + $GLOBALS['xmlrpcerr']['server_error'], + $GLOBALS['xmlrpcstr']['server_error'] . ": function does not return xmlrpcresp object" + ); + } + } + } + else + { + // call a 'plain php' function + if($sysCall) + { + array_unshift($params, $this); + $r = call_user_func_array($func, $params); + } + else + { + // 3rd API convention for method-handling functions: EPI-style + if ($this->functions_parameters_type == 'epivals') + { + $r = call_user_func_array($func, array($methName, $params, $this->user_data)); + // mimic EPI behaviour: if we get an array that looks like an error, make it + // an eror response + if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r)) + { + $r =& new xmlrpcresp(0, (integer)$r['faultCode'], (string)$r['faultString']); + } + else + { + // functions using EPI api should NOT return resp objects, + // so make sure we encode the return type correctly + $r =& new xmlrpcresp(php_xmlrpc_encode($r, array('extension_api'))); + } + } + else + { + $r = call_user_func_array($func, $params); + } + } + // the return type can be either an xmlrpcresp object or a plain php value... + if (!is_a($r, 'xmlrpcresp')) + { + // what should we assume here about automatic encoding of datetimes + // and php classes instances??? + $r =& new xmlrpcresp(php_xmlrpc_encode($r, array('auto_dates'))); + } + } + if($this->debug > 2) + { + // note: restore the error handler we found before calling the + // user func, even if it has been changed inside the func itself + if($GLOBALS['_xmlrpcs_prev_ehandler']) + { + set_error_handler($GLOBALS['_xmlrpcs_prev_ehandler']); + } + else + { + restore_error_handler(); + } + } + return $r; + } + + /** + * add a string to the 'internal debug message' (separate from 'user debug message') + * @param string $strings + * @access private + */ + function debugmsg($string) + { + $this->debug_info .= $string."\n"; + } + + /** + * @access private + */ + function xml_header($charset_encoding='') + { + if ($charset_encoding != '') + { + return "\n"; + } + else + { + return "\n"; + } + } + + /** + * A debugging routine: just echoes back the input packet as a string value + * DEPRECATED! + */ + function echoInput() + { + $r=&new xmlrpcresp(new xmlrpcval( "'Aha said I: '" . $GLOBALS['HTTP_RAW_POST_DATA'], 'string')); + print $r->serialize(); + } + } +?> \ No newline at end of file diff --git a/printer1.py b/printer1.py deleted file mode 100755 index a9e5b77..0000000 --- a/printer1.py +++ /dev/null @@ -1,237 +0,0 @@ -from gettext import gettext as _ -import logging -import sha -import socket -import struct - -import gtk -import gobject -import gconf -import dbus -import time -from datetime import date - -from sugar.graphics.icon import get_icon_state, Icon -from sugar.graphics import style -from sugar.graphics.palette import Palette -from sugar.graphics.toolbutton import ToolButton -from sugar.graphics.tray import TrayIcon -from sugar.graphics import xocolor -from sugar.util import unique_id -from sugar.graphics.menuitem import MenuItem -from sugar import profile -from jarabe.frame.frameinvoker import FrameWidgetInvoker - -from printscript import * - -_HAL_SERVICE = 'org.freedesktop.Hal' -_HAL_IFACE = 'org.freedesktop.Hal.Manager' -_HAL_PATH = '/org/freedesktop/Hal/Manager' -_PRINTER_SERVICE = 'org.freedesktop.Hal' -_PRINTER_PATH = '' -_PRINTER_IFACE = 'org.freedesktop.Hal.Device' -_SPOOLER_PATH="/com/redhat/PrinterSpooler" -_SPOOLER_IFACE="com.redhat.PrinterSpooler" -#_PRINTER_DEVICE_IFACE = 'org.freedesktop.NetworkManager.Device' -_ICON_NAME = 'printer' - - -class PrinterPalette(Palette): - - def __init__(self,name,): - - Palette.__init__(self, label=_('Printer')) - - self._model = DeviceModel() - - - logging.debug("hey this is 1" ) - self._hbars = {} - self._indexToidmapper = [] - self.tryJobs() - self.props.secondary_text = name - self.connectEvents() - - def connectEvents(self): - for key in self._hbars.keys(): - self._hbars[key].connect('activate',self.cancel,key) - #logging.debug("hey this got deleted %s",key) - - def clearMenu(self): - for key in self._hbars.keys(): - self.menu.remove(self._hbars[key]) - del self._hbars[key] - - def tryJobs(self): - self.clearMenu() - self._jobids = self._model.GetLiveJobs()[0] - self._jobids.sort() - try: - for jobid in self._jobids: - logging.debug(self._model.GetJobStatus(jobid)) - status=self._model.GetJobStatus(jobid) - title = self._model.GetJobTitle(jobid) - self.createHBars(status,title,jobid) - self._indexToidmapper.append(jobid) - except TypeError: - pass - - def cancel(self,widget,key): - self._model.CancelAJob(key) - self.menu.remove(self._hbars[key]) - #self.connectEvents(self) - del self._hbars[key] - - def createHBars(self,status,title,jobid): - self._cancel = MenuItem('') - self._icon = Icon(icon_size=gtk.ICON_SIZE_MENU) - self._cancel.set_image(self._icon) - self._icon.props.icon_name = 'dialog-cancel' - self._cancel.get_child().set_text ('Document:' + title + '\n' + status) - self.menu.append(self._cancel) - - self._cancel.show() - self._hbars[jobid]= self._cancel - - def redraw(self): - logging.debug("I come from class 1") - self._model.update() - self.tryJobs() - self.connectEvents() - -class DeviceModel(): - def __init__(self): - - self._cups = serverConnection() - self.update() - - def GetLiveJobs(self,): - return [self.livejobsKeys, self.livejobsDict] - - def GetJobStatus(self,jobkey): - if self.livejobsDict[jobkey]["job-state"] == 5: - return "Processing" - elif self.livejobsDict[jobkey]["job-state"] == 3: - return "Pending" - else: - return "Cancelled" - def GetJobTitle(self,jobkey): - return self.livejobsDict[jobkey]["job-name"] - - def CancelAJob(self,jobkey): - logging.debug("lololol") - logging.debug(jobkey) - self._cups._cancelAJob(jobkey) - - def update(self,): - self.livejobsDict = self._cups._getLiveJobQueue() - self.livejobsKeys = self.livejobsDict.keys() - -class PrinterDeviceView(TrayIcon): - - - FRAME_POSITION_RELATIVE = 301 - - def __init__(self,name): - client = gconf.client_get_default() - - sh = sha.new() - data = profile.get_nick_name() - sh.update(data) - h = hash(sh.digest()) - idx = h % len(xocolor.colors) - - color = xocolor.XoColor('%s,%s' % (xocolor.colors[idx][0], - xocolor.colors[idx][1])) - - TrayIcon.__init__(self, icon_name=_ICON_NAME, xo_color=color) - - self.set_palette_invoker(FrameWidgetInvoker(self)) - self._palette = PrinterPalette(name) - self.set_palette(self._palette) - self._palette.set_group_id('frame') - logging.debug('I come from PrinterDeviceView') - - def update_queue(self): - logging.debug("I come from class 2") - try: - gobject.source_remove(self.timer) - except AttributeError: - pass - - self.timer = gobject.timeout_add (500,self._palette.redraw) - #self._palette.redraw() -class PrinterManagerObserver(object): - def __init__(self, tray): - self._bus = dbus.SystemBus() - self._halmgr = None - self._tray = tray - self._devices = {} - - - try: - obj = self._bus.get_object(_HAL_SERVICE, _HAL_PATH) - self._halmgr = dbus.Interface(obj, _HAL_IFACE) - except dbus.DBusException: - logging.error('%s service not available', _HAL_SERVICE) - return - - self.find_Printers() - - self._halmgr.connect_to_signal('DeviceAdded', - self.device_added) - self._halmgr.connect_to_signal('DeviceRemoved', - self.device_removed,) - - self._bus.add_signal_receiver (self.update_lists, - path=_SPOOLER_PATH, - dbus_interface=_SPOOLER_IFACE) - def update_lists(self,*agrs): - logging.debug("I come from class 3") - try: - gobject.source_remove(self.timer) - except AttributeError: - pass - #self._device_view.update_queue() - self.timer = gobject.timeout_add (200,self._device_view.update_queue) - - - def find_Printers(self): - try: - printerLocation = self._halmgr.FindDeviceByCapability('printer') - - except AttributeError and IndexError: - logging.debug('No Print Device found') - else: - for printerLoc in printerLocation: - self.device_added(printerLoc) - - - - def device_added(self, printerLoc ): - - self.PrinterObj = self._bus.get_object(_PRINTER_SERVICE,printerLoc) - self.printeriface = dbus.Interface(self.PrinterObj, _PRINTER_IFACE) - try: - print self.printeriface.GetProperty('info.capabilities')[0] - except dbus.DBusException, IndexError: - return - self.properties = self.printeriface.GetAllProperties() - self.headerString = self.properties[u'info.vendor']+' '+self.properties[u'info.product'] - logging.debug('Print Device found %s',self.headerString) - self._device_view = PrinterDeviceView(self.headerString) - self._tray.add_device(self._device_view) - self._devices[printerLoc] = self._device_view - - def device_removed(self, printerLoc): - logging.debug('No Print Device found, so Disconnecting Device') - #self._device_view.disconnect() - self._tray.remove_device(self._devices[printerLoc]) - del self._devices[printerLoc] - self._devices[printerLoc] = None - - - - -def setup(tray): - device_observer = PrinterManagerObserver(tray) -- cgit v0.9.1