/comms.php

Large files files are truncated, but you can click here to view the full file

<?php
/**
 * The Turnitin API Communication Class
 *
 * @package turnitintool
 * @subpackage classes
 * @copyright 2012 Turnitin
 */
class turnitintool_commclass {
    /**
     * @var string $apiurl The API Url
     */
    var $apiurl;
    /**
     * @var boolean $encrypt The encrypt parameter for API calls
     */
    var $encrypt;
    /**
     * @var int $accountid The Account ID parameter for API calls
     */
    var $accountid;
    /**
     * @var int $utp The user type parameter for API calls
     */
    var $utp;
    /**
     * @var int $uid The User ID parameter for API calls
     */
    var $uid;
    /**
     * @var string $ufn The User Firstname parameter for API calls
     */
    var $ufn;
    /**
     * @var string $uln The User Lastname parameter for API calls
     */
    var $uln;
    /**
     * @var string $uem The User Email parameter for API calls
     */
    var $uem;
    /**
     * @var string $tiisession Turnitin Session ID parameter for API calls
     */
    var $tiisession;
    /**
     * @var object $loaderbar The Loader Bar Object NULL if no loaderbar is to be displayed
     */
    var $loaderbar;
    /**
     * @var string $result The entires xml result from the API call
     */
    var $result;
    /**
     * @var int $rcode The RCODE returned by the API call
     */
    var $rcode;
    /**
     * @var string $rmessage The RMESSAGE returned by the API call
     */
    var $rmessage;
    /**
     * @var string $curlerror The curl_error returned by the API call if connection issues occur in curl
     */
    var $curlerror;
    /**
     * A backward compatible constructor / destructor method that works in PHP4 to emulate the PHP5 magic method __construct
     * Disabled to remove strict warnings, only useful for PHP 4 and there shouldn't be too many PHP 4 installs around by now
     */
    /*function turnitintool_commclass($iUid,$iUfn,$iUln,$iUem,$iUtp,&$iLoaderBar) {
        if (version_compare(PHP_VERSION,"5.0.0","<")) {
            $this->__construct($iUid,$iUfn,$iUln,$iUem,$iUtp,$iLoaderBar);
        }
    }*/
    /**
     * The constructor for the class, Calls the startsession() method if we are using sessions
     *
     * @param int $iUid The User ID passed in the class creation call
     * @param string $iUfn The User First Name passed in the class creation call
     * @param string $iUln The User Last Name passed in the class creation call
     * @param string $iUem The User Email passed in the class creation call
     * @param int $iUtp The User Type passed in the class creation call
     * @param object $iLoaderBar The Loader Bar object passed in the class creation call (may be NULL if no loaderbar is to be used)
     * @param boolean $iUseSession Determines whether we start a session for this call (set to false for SSO calls)
     */
    function __construct($iUid,$iUfn,$iUln,$iUem,$iUtp,&$iLoaderBar) {
        global $CFG;
        $this->callback=false;
        $this->apiurl=$CFG->turnitin_apiurl;
        $this->accountid=$CFG->turnitin_account_id;
        $this->uid=$iUid;
        
        // Convert the email, firstname and lastname to psuedos for students if the option is set in config
        // Unless the user is already logged as a tutor then use real details
        if ( isset( $CFG->turnitin_enablepseudo ) AND $CFG->turnitin_enablepseudo == 1 AND $iUtp == 1 AND !turnitintool_istutor( $iUem ) ) {
            $iUfn = turnitintool_pseudofirstname();
            $iUln = turnitintool_pseudolastname( $iUem );
            $iUem = turnitintool_pseudoemail( $iUem );
        }
        
        $this->ufn=$iUfn;
        $this->uln=$iUln;
        $this->uem=$iUem;
        $this->utp=$iUtp;
        $this->loaderbar =& $iLoaderBar;
    }
    /**
     * Calls FID1, FCMD 2 with create_session set to 1 in order to create a session for this user / object call
     */
    function startSession() {
        global $CFG;
        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fid'=>1,
                'fcmd'=>2,
                'utp'=>$this->utp,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['create_session']=1;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true);
        $this->tiisession=$this->getSessionid();
        sleep(TURNITINTOOL_LATENCY_SLEEP);
    }
    /**
     * Calls FID18, FCMD 2 to kill the session for this user / object call
     */
    function endSession() {
        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fid'=>18,
                'fcmd'=>2,
                'utp'=>$this->utp,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true);
    }
    /**
    * disableEmail - determines whether to use dis=0 or dis=1
    *
    * @param boolean $submission true for a submission call false otherwise
    * @return string 1 or 0
    */
    function disableEmail($submission=false) {
        global $CFG;
        if ( ($this->utp==1 AND $CFG->turnitin_receiptemail!="1" AND $submission) OR  // If student and submission and sends receipts = no
             ($this->utp==1 AND $CFG->turnitin_studentemail!="1" AND !$submission) OR // If student and not submission and student emails = no
             ($this->utp==2 AND $CFG->turnitin_tutoremail!="1") ) {                   // If instructor and instructor emails = no
            return "1";
        } else {
            return "0";
        }
    }
    /**
     * Converts XML string to array using SimpleXMLElement
     *
     * @param string $string
     * @return boolean
     */
    function xmlToSimple( $string, $error = true ) {
        try {
            @$this->simplexml = new SimpleXMLElement( $string );
        } catch ( Exception $e ) {
            if ( $error ) {
                turnitintool_print_error('apiunavailable','turnitintool',NULL,NULL,__FILE__,__LINE__);
                exit();
            }
            return false;
        }
        return true;
    }
    /**
     * Returns a multidimensional array built in the format array[OBJECTID][fieldname]
     *
     * @return array
     */
    function getSubmissionArray() {
        $output=array();
        
        $this->xmlToSimple( $this->result );
        $objects = $this->simplexml->object;
        
        if ( !isset( $objects ) ) {
            return $output;
        }
        
        foreach ( $objects as $object ) {
            
            $objectid = (string)$object->objectID;

            $output[$objectid]["userid"] = (string)$object->userid;
            $output[$objectid]["firstname"] = (string)$object->firstname;
            $output[$objectid]["lastname"] = (string)$object->lastname;
            $output[$objectid]["title"] = html_entity_decode( (string)$object->title, ENT_QUOTES, "UTF-8" );
            
            $output[$objectid]["similarityscore"] = ( !is_null( $object->similarityScore ) AND $object->similarityScore != "-1" ) ? $object->similarityScore : null;

            $transsimilarityscore = (integer)$object->translated_matching->similarityScore < 0 ? null : $object->translated_matching->similarityScore;
            
            if ( !is_null( $transsimilarityscore ) ) {
                if ( (integer)$object->overlap > (integer)$object->translated_matching->overlap ) {
                    $output[$objectid]["transmatch"] = 0;
                    $high_overlap = $object->overlap;
                    $similarityscore = $object->similarityScore;
                } else {
                    $output[$objectid]["transmatch"] = 1;
                    $high_overlap = $object->translated_matching->overlap;
                    $similarityscore = $object->translated_matching->similarityScore;
                }
            } else {
                $high_overlap = $object->overlap;
                $output[$objectid]["transmatch"] = 0;
                $similarityscore = $object->similarityScore;
            }

            // note overlap is the Originality Percentage Score
            $output[$objectid]["overlap"] = ( !is_null( $high_overlap ) AND $similarityscore != "-1" ) ? (string)$high_overlap : null;

            $score = (string)$object->score;
            $output[$objectid]["grademark"] = ( $score === '0' OR ( !is_null( $score ) AND $score != "-1" ) ) ? $score : null;

            $anon = (string)$object->anon;
            $output[$objectid]["anon"] = ( !is_null( $anon ) AND $anon != "-1" ) ? $anon : null;
            
            $grademarkstatus = (string)$object->gradeMarkStatus;
            $output[$objectid]["grademarkstatus"]=(!is_null( $grademarkstatus ) AND $grademarkstatus != "-1" ) ? $grademarkstatus : null;
            
            $date_submitted = (string)$object->date_submitted;
            $output[$objectid]["date_submitted"]=( !is_null( $date_submitted ) AND $date_submitted != "-1" ) ? $date_submitted : null;

            $student_view = isset($object->student_responses) ? (string)$object->student_responses->student_response->response_time : null;
            $output[$objectid]["student_view"]=( isset( $object->student_responses ) AND !is_null( $student_view ) AND !empty( $student_view ) ) ? $student_view : 0;
        
        }
        return $output;

    }

    /**
     * Returns the Session ID for the API call
     *
     * @return string The Session ID String or Empty if not available
     */
    function getSessionid() {
        if ( $this->xmlToSimple( $this->result ) AND !is_null( $this->simplexml->sessionid ) ) {
            return (string)$this->simplexml->sessionid;
        } else {
            return '';
        }
    }
    /**
     * Returns the Return Message (rmessage) for the API call
     *
     * @return string The RMESSAGE or Empty if not available
     */
    function getRmessage() {
        if ( $this->xmlToSimple( $this->result ) ) {
            return (string)$this->simplexml->rmessage;
        } else if (strlen($this->curlerror)>0) {
            return 'CURL ERROR: '.$this->curlerror;
        } else {
            return '';
        }
    }
    /**
     * Returns the User ID for the API call
     *
     * @return integer The USERID or Empty if not available
     */
    function getUserID() {
        if ( $this->xmlToSimple( $this->result ) ) {
            return (integer)$this->simplexml->userid;
        } else {
            return '';
        }
    }
    /**
     * Returns the Class ID for the API call
     *
     * @return integer The CLASSID or Empty if not available
     */
    function getClassID() {
        if ( $this->xmlToSimple( $this->result ) ) {
            return (integer)$this->simplexml->classid;
        } else {
            return '';
        }
    }
    /**
     * Returns the Return Code (rcode) for the API call
     *
     * @return integer The RCODE or NULL if not available
     */
    function getRcode() {
        if ( $this->xmlToSimple( $this->result ) ) {
            return (integer)$this->simplexml->rcode;
        } else {
            return NULL;
        }
    }
    /**
     * Returns the Error State for the API call
     *
     * @return boolean True API call success or False API failure
     */
    function getRerror() {
        if (is_null($this->getRcode()) OR $this->getRcode()>=TURNITINTOOL_API_ERROR_START) {
            return true;
        } else {
            return false;
        }
    }
    /**
     * Checks the availability of the API
     *
     * @return boolean Returns a true if the API has returned an RCODE or false if unavailable
     */
    function getAPIunavailable() {
        if (is_null($this->getRcode())) {
            return true;
        } else {
            return false;
        }
    }
    /**
     * Returns the Object ID (objectid) for the API call
     *
     * @return integer The OBJECTID or Empty String if not available
     */
    function getObjectid() {
        if ( $this->xmlToSimple( $this->result ) ) {
            return (integer)$this->simplexml->objectID;
        } else {
            return '';
        }
    }
    /**
     * Returns the Assignment ID (ASSIGNMENTID) for the API call
     *
     * @return integer The ASSIGNMENTID or Empty String if not available
     */
    function getAssignid() {
        if ( $this->xmlToSimple( $this->result ) ) {
            return (integer)$this->simplexml->assignmentid;
        } else {
            return '';
        }
    }
    /**
     * Returns the Originality Score (ORIGINALITYSCORE) for the API call
     *
     * @return string The ORIGINALITYSCORE or Empty String if not available
     */
    function getScore() {
        if ( $this->xmlToSimple( $this->result ) AND !is_null( $this->simplexml->originalityscore ) ) {
            return (string)$this->simplexml->originalityscore;
        } else {
            return '';
        }
    }
    /**
     * Returns the Overall Grade (SCORE) for the API call
     *
     * @return string The SCORE or Empty String if not available
     */
    function getGrade() {
        if ( $this->xmlToSimple( $this->result ) AND !is_null( $this->simplexml->originalityscore ) ) {
            return (string)$this->simplexml->score;
        } else {
            return '';
        }
    }
    /**
     * Does a HTTPS Request using cURL and returns the result
     *
     * @param string $method The request method to use POST or GET
     * @param string $url The URL to send the request to
     * @param string $vars A query string style name value pair string (e.g. name=value&name2=value2)
     * @param boolean $timeout Whether to timeout after 240 seconds or not timeout at all
     * @param string $status The status to pass to the loaderbar redraw method
     * @return string The result of the HTTPS call
     */
    function doRequest($method, $url, $vars, $timeout=true, $status="") {
        global $CFG;
        $this->result=NULL;
        if (is_callable(array($this->loaderbar,'redrawbar'))) {
            $this->loaderbar->redrawbar($status);
        }
        if ($timeout) {
            set_time_limit(240);
        } else {
            set_time_limit(0);
        }
        $ch = curl_init();
        $useragent="Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.1) Gecko/20061204 Firefox/2.0.0.1";
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_HEADER, 0);
        curl_setopt($ch, CURLOPT_USERAGENT, $useragent);
        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($ch, CURLOPT_ENCODING, '');
        curl_setopt($ch, CURLOPT_MAXREDIRS, 10);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);

        $cacertfile = $CFG->dataroot . '/moodleorgca.crt';
        if ( is_readable( $cacertfile ) ) {
            curl_setopt( $ch, CURLOPT_CAINFO, $cacertfile );
        }

        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 20);
        if (isset($CFG->turnitin_proxyurl) AND !empty($CFG->turnitin_proxyurl)) {
            curl_setopt($ch, CURLOPT_PROXY, $CFG->turnitin_proxyurl.':'.$CFG->turnitin_proxyport);
        }
        if (isset($CFG->turnitin_proxyuser) AND !empty($CFG->turnitin_proxyuser)) {
            curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
            curl_setopt($ch, CURLOPT_PROXYUSERPWD, sprintf('%s:%s', $CFG->turnitin_proxyuser, $CFG->turnitin_proxypassword));
        }
        if ($timeout) {
            curl_setopt($ch, CURLOPT_TIMEOUT, 240);
        }
        if ($method == 'POST') {
            //curl_setopt($ch, CURLOPT_POST, 1);
            curl_setopt($ch, CURLOPT_POSTFIELDS, $vars);
        }
        $data = curl_exec($ch);
        if ($data) {
            $result=$data;
        } else {
            $result=curl_error($ch);
            $this->curlerror=$result;
        }
        $this->doLogging($vars,$result);
        return utf8_decode($result);
        curl_close($ch);
        fclose($temp_pem);

    }
    /**
     * Logging function to log outgoing API calls and the return XML
     *
     * @param string $vars The query variables passed to the API
     * @param string $result The Result of the query
     */
    function doLogging($vars,$result) {
        global $CFG;
        if ( $CFG->turnitin_enablediagnostic AND !empty( $vars ) ) {
            $this->result=$result;
            // ###### DELETE SURPLUS LOGS #########
            $numkeeps=10;
            $prefix="commslog_";
            $dirpath=$CFG->dataroot."/temp/turnitintool/logs";
            if (!file_exists($dirpath)) {
                mkdir($dirpath,0777,true);
            }
            $dir=opendir($dirpath);
            $files=array();
            while ($entry=readdir($dir)) {
                if (substr(basename($entry),0,1)!="." AND substr_count(basename($entry),$prefix)>0) {
                    $files[]=basename($entry);
                }
            }
            sort($files);
            for ($i=0;$i<count($files)-$numkeeps;$i++) {
                unlink($dirpath."/".$files[$i]);
            }
            // ####################################
            $newline = "\r\n";
            $filepath=$dirpath."/".$prefix.date('Ymd',time()).".log";
            $file=fopen($filepath,'ab');
            $fid = isset($vars["fid"]) ? $vars["fid"] : "N/A";
            $fcmd = isset($vars["fcmd"]) ? $vars["fcmd"] : "N/A";
            $output="== FID:".$fid." | FCMD:".$fcmd." ===========================================================".$newline;
            $output.="== RESPONSE =====================================================================".$newline;
            $output.="CALL DATE TIME: ".date('r',time()).$newline;
            $output.="URL: ".$this->apiurl.$newline;
            $output.="------------------------------------------------------------------------------".$newline;
            $output.="REQUEST VARS: ".PHP_EOL.str_replace("\n","\r\n",str_replace("\r\r\n","\r\n",print_r($vars,true))).$newline;
            $output.="------------------------------------------------------------------------------".$newline;
            $output.="RESPONSE: ".PHP_EOL.PHP_EOL.str_replace("\n","\r\n",str_replace("\r\r\n","\r\n",$result)).$newline;
            $output.="##############################################################################".$newline.$newline;
            fwrite($file,$output);
            fclose($file);
        }
    }
    /**
     * Call to API FID4, FCMD6 that deletes an assignment from Turnitin
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function deleteAssignment($post,$status) {
        global $CFG;

        if (!turnitintool_check_config()) {
            turnitintool_print_error('configureerror','turnitintool',NULL,NULL,__FILE__,__LINE__);
            exit();
        }

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>6,
                'cid'=>$post->cid,
                'ctl'=>stripslashes($post->ctl),
                'assignid'=>$post->assignid,
                'assign'=>stripslashes($post->name),
                'utp'=>2,
                'fid'=>4,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata["md5"]=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID4, FCMD2/FCMD3 that creates/updates an assignment in Turnitin
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $do The call type 'INSERT' or 'UPDATE'
     * @param string $status The status to pass to the loaderbar class
     */
    function createAssignment($post,$do='INSERT',$status) {
        global $CFG;
        
        if (!turnitintool_check_config()) {
            turnitintool_print_error('configureerror','turnitintool',NULL,NULL,__FILE__,__LINE__);
            exit();
        }

        if ($do!='INSERT') {
            $thisfcmd=3;
            $userid=$this->uid;
        } else {
            $thisfcmd=2;
            $userid='';
        }
        
        // Use the Moodle Default Timezone and fallback on Server timzone if config not set
        $timezone = isset( $CFG->timezone ) ? $CFG->timezone : 20;

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>$thisfcmd,
                'cid'=>$post->cid,
                'ctl'=>stripslashes($post->ctl),
                'assignid'=>$post->assignid,
                'utp'=>2,
                'dtstart'=>userdate($post->dtstart,'%Y-%m-%d %H:%M:%S',$timezone,false), // Default Moodle Timezone
                'dtdue'=>userdate($post->dtdue,'%Y-%m-%d %H:%M:%S',$timezone,false), // Default Moodle Timezone
                'dtpost'=>userdate($post->dtpost,'%Y-%m-%d %H:%M:%S',$timezone,false), // Default Moodle Timezone
                'fid'=>4,
                'uid'=>$userid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        if ($do!='INSERT') {
            $assigndata['newassign']=stripslashes($post->name);
            $assigndata['assign']=stripslashes($post->currentassign);
        } else {
            $assigndata['assign']=stripslashes($post->name);
        }
        $assigndata['dis']=$this->disableEmail();
        $assigndata["md5"]=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata["s_view_report"]=$post->s_view_report;
        if (isset($post->max_points)) {
            $assigndata["max_points"]=$post->max_points;
        }
        if (isset($post->report_gen_speed)) {
            $assigndata["report_gen_speed"]=$post->report_gen_speed;
        }
        if (isset($post->anon)) {
            $assigndata["anon"]=$post->anon;
        }
        if (isset($post->late_accept_flag)) {
            $assigndata["late_accept_flag"]=$post->late_accept_flag;
        }
        if (isset($post->submit_papers_to)) {
            $assigndata["submit_papers_to"]=$post->submit_papers_to;
        }
        if (isset($post->s_paper_check)) {
            $assigndata["s_paper_check"]=$post->s_paper_check;
        }
        if (isset($post->internet_check)) {
            $assigndata["internet_check"]=$post->internet_check;
        }
        if (isset($post->journal_check)) {
            $assigndata["journal_check"]=$post->journal_check;
        }
        // Add Exclude small matches, biblio, quoted etc 20100920
        if (isset($post->exclude_biblio)) {
            $assigndata["exclude_biblio"]=$post->exclude_biblio;
        }
        if (isset($post->exclude_quoted)) {
            $assigndata["exclude_quoted"]=$post->exclude_quoted;
        }
        if (isset($post->exclude_value)) {
            $assigndata["exclude_value"]=$post->exclude_value;
        }
        if (isset($post->exclude_type) AND $assigndata["exclude_value"]==0) {
            $assigndata["exclude_type"]=0;
        } else if (isset($post->exclude_type)) {
            $assigndata["exclude_type"]=$post->exclude_type;
        }
        if (isset($post->erater) AND $post->erater != 0) {
            $assigndata["erater"]=$post->erater;
            $assigndata["ets_handbook"]=$post->erater_handbook;
            $assigndata["ets_dictionary"]=$post->erater_dictionary;
            $assigndata["ets_spelling"]=$post->erater_spelling;
            $assigndata["ets_grammar"]=$post->erater_grammar;
            $assigndata["ets_usage"]=$post->erater_usage;
            $assigndata["ets_mechanics"]=$post->erater_mechanics;
            $assigndata["ets_style"]=$post->erater_style;
        }
        if (isset($post->transmatch)) {
            $assigndata["translated_matching"]=$post->transmatch;
        }
        if (isset($post->idsync)) {
            $assigndata['idsync']=$post->idsync;
        }
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID2, FCMD4 that changes the owner tutor for a Turnitin class
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function changeOwner($post,$status) {

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>4,
                'cid'=>$post->cid,
                'ctl'=>stripslashes($post->ctl),
                'tem'=>$this->uem,
                'utp'=>2,
                'fid'=>2,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $assigndata['new_teacher_email']=$post->new_teacher_email;

        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID5, FCMD2 that submits a paper to Turnitin
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $filedata The filepath / filedata of the file to upload
     * @param string $status The status to pass to the loaderbar class
     */
    function submitPaper($post,$filedata,$status) {

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>2,
                'cid'=>$post->cid,
                'ctl'=>stripslashes($post->ctl),
                'assignid'=>$post->assignid,
                'assign'=>stripslashes($post->assignname),
                'tem'=>$post->tem,
                'ptype'=>2,
                'ptl'=>stripslashes($post->papertitle),
                'utp'=>1,
                'fid'=>5,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln,
                'oid'=>$post->oid
        );
        $assigndata['dis']=$this->disableEmail(true);
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $assigndata['pdata']='@'.$filedata;

        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,false,$status);
    }
    /**
     * Call to API FID4, FCMD7 that queries the settings for the Turnitin assignment
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function queryAssignment($post,$status) {

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>7,
                'cid'=>$post->cid,
                'ctl'=>stripslashes($post->ctl),
                'assignid'=>$post->assignid,
                'assign'=>stripslashes($post->assign),
                'utp'=>2,
                'fid'=>4,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Converts the Turnitin Assignment settings to an object in the correct format for a create/update assignment call
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function getAssignmentObject() {
        $output=new object();
        $xmlcall=$this->xmlToSimple($this->result);
        if ( isset($this->simplexml->object->assign) ) {
            $output->assign = (string)$this->simplexml->object->assign;
            $output->dtstart = (integer)$this->simplexml->object->dtstart;
            $output->dtdue = (integer)$this->simplexml->object->dtdue;
            $output->dtpost = (integer)$this->simplexml->object->dtpost;
            $output->ainst = (string)$this->simplexml->object->ainst;
            $output->report_gen_speed = (integer)$this->simplexml->object->generate;
            $output->s_view_report = (boolean)$this->simplexml->object->sviewreports;
            $output->late_accept_flag = (boolean)$this->simplexml->object->latesubmissions;
            $output->submit_papers_to = (integer)$this->simplexml->object->repository;
            $output->s_paper_check = (boolean)$this->simplexml->object->searchpapers;
            $output->internet_check = (boolean)$this->simplexml->object->searchinternet;
            $output->journal_check = (boolean)$this->simplexml->object->searchjournals;
            $output->anon = (boolean)$this->simplexml->object->anon;
            $output->maxpoints = (integer)$this->simplexml->object->maxpoints;
            return $output;
        } else {
            return $output;
        }
    }
    /**
     * Call to API FID3, FCMD2 to join the user to a Turnitin Class
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function joinClass($post,$status) {

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>2,
                'cid'=>$post->cid,
                'ctl'=>stripslashes($post->ctl),
                'tem'=>stripslashes($post->tem),
                'utp'=>1,
                'fid'=>3,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID1, FCMD2 to create a user on the Turnitin System
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function createUser($post,$status) {
        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>2,
                'utp'=>$this->utp,
                'fid'=>1,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        if (isset($post->idsync)) {
            $assigndata['idsync']=$post->idsync;
        }
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID1, FCMD2 to create a class on the Turnitin System
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function createClass($post,$status,$type="INSERT") {

        if (!isset($post->cid)) {
            $post->cid="";
            $userid="";
        } else {
            $userid=$this->uid;
        }
        $ced = isset( $post->ced ) ? $post->ced : null;
        if ( $type == "INSERT" ) {
            $fcmd = 2;
        } else {
            $fcmd = 3;
        }

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>$fcmd,
                'utp'=>2,
                'fid'=>2,
                'cid'=>$post->cid,
                'ctl'=>stripslashes($post->ctl),
                'uid'=>$userid,
                'uem'=>$this->uem,
                'ced'=>$ced,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        if (isset($post->idsync)) {
            $assigndata['idsync']=$post->idsync;
        }
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID6, FCMD2 to get the Originality Report score
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function getReportScore($post,$status) {

        if (!turnitintool_check_config()) {
            turnitintool_print_error('configureerror','turnitintool',NULL,NULL,__FILE__,__LINE__);
            exit();
        }

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>2,
                'oid'=>$post->paperid,
                'utp'=>$post->utp,
                'fid'=>6,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata["md5"]=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID15, FCMD2 to get the GradeMark score
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function getGradeMark($post,$status) {

        if (!turnitintool_check_config()) {
            turnitintool_print_error('configureerror','turnitintool',NULL,NULL,__FILE__,__LINE__);
            exit();
        }

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>2,
                'oid'=>$post->oid,
                'utp'=>2,
                'fid'=>15,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata["md5"]=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID10, FCMD2 to list the Submissions for an Assignment
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function listSubmissions($post,$status) {

        if (!turnitintool_check_config()) {
            turnitintool_print_error('configureerror','turnitintool',NULL,NULL,__FILE__,__LINE__);
            exit();
        }

        $fcmd = (isset($post->fcmd) AND $post->fcmd==4) ? 4 : 2;
        $tem = (isset($post->tem)) ? $post->tem : '';

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>$fcmd,
                'assignid'=>$post->assignid,
                'assign'=>$post->assign,
                'cid'=>$post->cid,
                'ctl'=>$post->ctl,
                'tem'=>$tem,
                'utp'=>$this->utp,
                'fid'=>10,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata["md5"]=$this->doMD5($assigndata);
        if ( !is_null( $this->tiisession ) ) $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID10, FCMD2 to list the Enrolled users
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function listEnrollment($post,$status) {

        if (!turnitintool_check_config()) {
            turnitintool_print_error('configureerror','turnitintool','',NULL,__FILE__,__LINE__);
            exit();
        }

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>5,
                'cid'=>$post->cid,
                'ctl'=>$post->ctl,
                'utp'=>$this->utp,
                'fid'=>19,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata["md5"]=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID19, FCMD2 to unenrol user from class
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function unenrolUser($post,$status) {

        if (!turnitintool_check_config()) {
            turnitintool_print_error('configureerror','turnitintool','',NULL,__FILE__,__LINE__);
            exit();
        }

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>2,
                'cid'=>$post->cid,
                'ctl'=>$post->ctl,
                'utp'=>$this->utp,
                'fid'=>19,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata["md5"]=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
    /**
     * Call to API FID2, FCMD2 to update the class having the effect of enrolling the tutor to that class
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @param string $status The status to pass to the loaderbar class
     */
    function enrolTutor($post,$status) {

        if (!turnitintool_check_config()) {
            turnitintool_print_error('configureerror','turnitintool','',NULL,__FILE__,__LINE__);
            exit();
        }

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>2,
                'cid'=>$post->cid,
                'ctl'=>$post->ctl,
                'utp'=>$this->utp,
                'fid'=>2,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['dis']=$this->disableEmail();
        $assigndata["md5"]=$this->doMD5($assigndata);
        $assigndata['session-id']=$this->tiisession;
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();
        $this->result=$this->doRequest("POST", $this->apiurl, $assigndata,true,$status);
    }
     /**
     * Output an array of tutors from a listEnrollment call
     *
     * @param object $post The post object that contains the necessary query
     * parameters for the listEnrollment call
     * @param string $status The status to pass to the loaderbar class
     * return array Returns an array of tutors with key of Turnitin UID
     */
    function getTutors($post,$status) {
        $this->listEnrollment($post,$status);
        $result=null;
        $this->xmlToSimple( $this->result );
        if ( isset( $this->simplexml->instructors->instructor ) ) $result = $this->simplexml->instructors->instructor;
        return $result;
    }
     /**
     * Output an array of students from a listEnrollment call
     *
     * @param object $post The post object that contains the necessary query
     * parameters for the listEnrollment call
     * @param string $status The status to pass to the loaderbar class
     * return array Returns an array of tutors with key of Turnitin UID
     */
    function getStudents($post,$status) {
        $this->listEnrollment($post,$status);
        $result=null;
        $this->xmlToSimple( $this->result );
        if ( isset( $this->simplexml->students->student ) ) $result = $this->simplexml->students->student;
        return $result;
    }
    /**
     * Call to API FID6, FCMD1 to Single Sign On to Turnitin's Originality Report for the submission
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @return string Returns the URL to access the Originality Report
     */
    function getReportLink($post) {

        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>1,
                'oid'=>$post->paperid,
                'utp'=>$this->utp,
                'fid'=>6,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();

        $keys = array_keys($assigndata);
        $values = array_values($assigndata);
        $querystring='';
        for ($i=0;$i<count($values); $i++) {
            if ($i!=0) {
                $querystring .= '&';
            }
            $querystring .= $keys[$i].'='.urlencode($values[$i]);
        }
        return $this->apiurl."?".$querystring;
    }
    /**
     * Call to API FID13, FCMD1 to Single Sign On to Turnitin's GradeMark for the submission
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @return string Returns the URL to access the GradeMark
     */
    function getGradeMarkLink($post) {
        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>1,
                'oid'=>$post->paperid,
                'utp'=>$this->utp,
                'fid'=>13,
                'uid'=>$this->uid,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();

        $keys = array_keys($assigndata);
        $values = array_values($assigndata);
        $querystring='';
        for ($i=0;$i<count($values); $i++) {
            if ($i!=0) {
                $querystring .= '&';
            }
            $querystring .= $keys[$i].'='.urlencode($values[$i]);
        }

        return $this->apiurl."?".$querystring;
    }
    /**
     * Call to API FID7, FCMD1 to Single Sign On to Turnitin's Submission View for the submission
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @return string Returns the URL to access the Submission View
     */
    function getSubmissionURL($post) {
        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>1,
                'oid'=>$post->paperid,
                'utp'=>$this->utp,
                'fid'=>7,
                'assignid'=>$post->assignid,
                'assign'=>$post->assign,
                'ctl'=>$post->ctl,
                'cid'=>$post->cid,
                'uid'=>$this->uid,
                'tem'=>$post->tem,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();

        $keys = array_keys($assigndata);
        $values = array_values($assigndata);
        $querystring='';
        for ($i=0;$i<count($values); $i++) {
            if ($i!=0) {
                $querystring .= '&';
            }
            $querystring .= $keys[$i].'='.urlencode($values[$i]);
        }
        return $this->apiurl."?".$querystring;
    }
    /**
     * Call to API FID7, FCMD2 to download the original paper of the submission
     *
     * @param object $post The post object that contains the necessary query parameters for the call
     * @return string Returns the URL to access the Download Link
     */
    function getSubmissionDownload($post) {
        $assigndata=array('gmtime'=>$this->tiiGmtime(),
                'encrypt'=>TURNITINTOOL_ENCRYPT,
                'aid'=>$this->accountid,
                'diagnostic'=>0,
                'fcmd'=>2,
                'oid'=>$post->paperid,
                'utp'=>$this->utp,
                'fid'=>7,
                'assignid'=>$post->assignid,
                'assign'=>$post->assign,
                'ctl'=>$post->ctl,
                'cid'=>$post->cid,
                'uid'=>$this->uid,
                'tem'=>$post->tem,
                'uem'=>$this->uem,
                'ufn'=>$this->ufn,
                'uln'=>$this->uln
        );
        $assigndata['md5']=$this->doMD5($assigndata);
        $assigndata['src']=TURNITINTOOL_APISRC;
        $assigndata['apilang']=$this->getLang();

        $keys = array_keys($assigndata);
        $values = array_values($assign…