/root/usr/share/nethesis/NethServer/Tool/phpprintipp/PrintIPP.php

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

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 foldmethod=marker: */
 /* @(#) $Header: /sources/phpprintipp/phpprintipp/php_classes/PrintIPP.php,v 1.3 2010/09/06 22:41:41 harding Exp $
 *
 * Class PrintIPP - Send IPP requests, Get and parses IPP Responses.
 *
 *   Copyright (C) 2005-2006  Thomas HARDING
 *   Parts Copyright (C) 2005-2006 Manuel Lemos
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Library General Public
 *   License as published by the Free Software Foundation; either
 *   version 2 of the License, or (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *   Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *   mailto:thomas.harding@laposte.net
 *   Thomas Harding, 56 rue de la bourie rouge, 45 000 ORLEANS -- FRANCE
 *   
 */
    
/*

    This class is intended to implement Internet Printing Protocol on client side.

    References needed to debug / add functionnalities:
        - RFC 2910
        - RFC 2911
        - RFC 3380
        - RFC 3382
*/
/*
    TODO: beta tests on other servers than Cups
*/


    // {{{ required and included files
            
            require_once("BasicIPP.php");
            
    // }}}


class PrintIPP extends BasicIPP {

    // {{{ constructor
    public function __construct() {
        parent::__construct();
    }
    // }}}

/*****************
*
* PUBLIC FUNCTIONS
*
*******************/
// SETTINGS

// OPERATIONS

    // {{{ printJob()
    public function printJob(){
        
        self::_putDebug( sprintf("*************************\nDate: %s\n*************************\n\n",date('Y-m-d H:i:s')));

        if (!$this->_stringJob())
            return FALSE;
                       
        if (is_readable($this->data)){
            self::_putDebug( _("Printing a FILE\n"),3); 
                
            $this->output = $this->stringjob;
           
            if ($this->setup->datatype == "TEXT")
                $this->output .= chr(0x16);
            
             
            $post_values = array( "Content-Type" => "application/ipp",
                                  "Data" => $this->output,
                                  "File" => $this->data);
            
            if ($this->setup->datatype == "TEXT" && !isset($this->setup->noFormFeed))
                $post_values = array_merge($post_values,array("Filetype"=>"TEXT"));
            
        } else {                      
            self::_putDebug( _("Printing DATA\n"),3); 
            
            $this->output = $this->stringjob;
            $this->output .= $this->datahead;    
            $this->output .= $this->data;
            $this->output .= $this->datatail;
            
            $post_values = array( "Content-Type" => "application/ipp",
                                  "Data" => $this->output);
             
            
            }
            
        if (self::_sendHttp ($post_values,$this->paths['printers'])) {
        
            if(self::_parseServerOutput()) {
                $this->_getJobId();
                $this->_getJobUri();
                $this->_parseJobAttributes();
            } else {
                $this->jobs = array_merge($this->jobs,array(''));
                $this->jobs_uri = array_merge($this->jobs_uri,array(''));
                }

            }
        
        if (isset($this->serveroutput) && isset($this->serveroutput->status)) {
            
            $this->status = array_merge($this->status,array($this->serveroutput->status));

            if ($this->serveroutput->status == "successfull-ok")
            {
              self::_errorLog(sprintf("printing job %s: ",$this->last_job) .$this->serveroutput->status,3);
            }
            else
            {
                $this->jobs = array_merge($this->jobs,array(""));
                $this->jobs_uri = array_merge($this->jobs_uri,array(""));
                self::_errorLog(sprintf("printing job: ",$this->last_job) .$this->serveroutput->status,1);
                if ($this->with_exceptions)
                {
                   throw new ippException(sprintf("job status: %s",
                    $this->serveroutput->status));
                }
            }
            return $this->serveroutput->status; 
            
            }

        $this->status = array_merge($this->status,array("OPERATION FAILED"));
        $this->jobs = array_merge($this->jobs,array(""));
        $this->jobs_uri = array_merge($this->jobs_uri,array(""));
        self::_errorLog("printing job : OPERATION FAILED",1);
    
    return false;
    }
    // }}}

    // {{{ cancelJob ($job_uri)
    public function cancelJob ($job_uri) {
        
        $this->jobs = array_merge($this->jobs,array(""));
        $this->jobs_uri = array_merge($this->jobs_uri,array(""));
        
        self::_putDebug( sprintf("*************************\nDate: %s\n*************************\n\n",date('Y-m-d H:i:s')));
        
        if (!$this->_stringCancel($job_uri))
        return FALSE;
                       
        self::_putDebug( _("Cancelling Job $job_uri\n"),3); 
            
        $this->output = $this->stringjob;
          
        $post_values = array( "Content-Type"=>"application/ipp",
                              "Data"=>$this->output);
            
        if (self::_sendHttp ($post_values,$this->paths['jobs']))
            self::_parseServerOutput();
          
        
        if (isset($this->serveroutput) && isset($this->serveroutput->status)) {
            
            $this->status = array_merge($this->status,array($this->serveroutput->status));

            if ($this->serveroutput->status == "successfull-ok")
                self::_errorLog("cancelling job $job_uri: ".$this->serveroutput->status,3);
            else            
                self::_errorLog("cancelling job $job_uri: ".$this->serveroutput->status,1);
            return $this->serveroutput->status; 

            }

            $this->status = array_merge($this->status,array("OPERATION FAILED"));
            self::_errorLog("cancelling job : OPERATION FAILED",3);
            
    return false;
    }
    // }}}

    // {{{  validateJob ()
    public function validateJob () {
        
        $this->jobs = array_merge($this->jobs,array(""));
        $this->jobs_uri = array_merge($this->jobs_uri,array(""));
        
        $this->serveroutput->response = '';

        self::_putDebug( sprintf("*************************\nDate: %s\n*************************\n\n",date('Y-m-d H:i:s')));
        
                       
        self::_putDebug( _("Validate Job\n"),2); 
                
        if (!isset($this->setup->charset))
            self::setCharset('us-ascii');
        if (!isset($this->setup->datatype))
            self::setBinary();

        if (!isset($this->setup->uri)) {
            $this->getPrinters();
            unset($this->jobs[count($this->jobs) - 1]);
            unset($this->jobs_uri[count($this->jobs_uri) - 1]);
            unset($this->status[count($this->status) - 1]);
            
            if (array_key_exists(0,$this->available_printers))
               self::setPrinterURI($this->available_printers[0]);
            else {
                trigger_error(_("_stringJob: Printer URI is not set: die"),E_USER_WARNING);
                self::_putDebug( _("_stringJob: Printer URI is not set: die\n"),3);
                self::_errorLog(" Printer URI is not set, die",2);
                return FALSE;
                }
            }
        
        if (!isset($this->meta->copies))
            self::setCopies(1);
        if (!isset($this->setup->copies))
            self::setCopies(1);
        
        if (!isset($this->setup->language))
            self::setLanguage('en_us');

        if (!isset($this->setup->mime_media_type))
            self::setMimeMediaType();
        if ($this->setup->datatype != "TEXT")
        unset ($this->setup->mime_media_type);
            
        if (!isset($this->setup->jobname))
            if (is_readable($this->data))
                self::setJobName(basename($this->data),true);
            else
                self::setJobName();
        unset($this->setup->jobname);

        if (!isset($this->meta->username))
            self::setUserName();

        if (!isset($this->meta->fidelity))
            $this->meta->fidelity = '';
        
        if (!isset($this->meta->document_name))
            $this->meta->document_name = '';

        if (!isset($this->meta->sides))
            $this->meta->sides = '';
        
        if (!isset($this->meta->page_ranges))
            $this->meta->page_ranges = '';
       
        $jobattributes = '';
        $operationattributes = '';
        $printerattributes = '';
        self::_buildValues ($operationattributes,$jobattributes,$printerattributes);
       
        self::_setOperationId();

        $this->stringjob = chr(0x01) . chr(0x01) // 1.1  | version-number
                         . chr(0x00) . chr (0x04) // Validate-Job | operation-id
                         . $this->meta->operation_id //           request-id
                         . chr(0x01) // start operation-attributes | operation-attributes-tag
                         . $this->meta->charset
                         . $this->meta->language
                         . $this->meta->printer_uri
                         . $this->meta->username
                         . $this->meta->jobname
                         . $this->meta->fidelity
                         . $this->meta->document_name
                         . $this->meta->mime_media_type
                         . $operationattributes
                         . chr(0x02) // start job-attributes | job-attributes-tag
                         . $this->meta->copies
                         . $this->meta->sides
                         . $this->meta->page_ranges
                         . $jobattributes
                         . chr(0x03); // end-of-attributes | end-of-attributes-tag
        

        self::_putDebug( sprintf(_("String sent to the server is:\n%s\n"), $this->stringjob));
 
        $this->output = $this->stringjob;
          
        $post_values = array( "Content-Type"=>"application/ipp",
                              "Data"=>$this->output);
            
        if (self::_sendHttp ($post_values,$this->paths['printers']))
                if(self::_parseServerOutput())
                    self::_parseAttributes();
          
        
        if (isset($this->serveroutput) && isset($this->serveroutput->status)) {
            
            $this->status = array_merge($this->status,array($this->serveroutput->status));

            if ($this->serveroutput->status == "successfull-ok")
                self::_errorLog("validate job: ".$this->serveroutput->status,3);
            else            
                self::_errorLog("validate job: ".$this->serveroutput->status,1);
            
            return $this->serveroutput->status; 

            }

            $this->status = array_merge($this->status,array("OPERATION FAILED"));
            self::_errorLog("validate job : OPERATION FAILED",3);
            
    return false;
    }
    // }}}

    // {{{ getPrinterAttributes()
    public function getPrinterAttributes() {
        
        $this->jobs = array_merge($this->jobs,array(""));
        $this->jobs_uri = array_merge($this->jobs_uri,array(""));

        $jobattributes = '';
        $operationattributes = '';
        self::_buildValues($operationattributes,$jobattributes,$printerattributes);
        self::_setOperationId();
        $this->parsed = array();
        unset($this->printer_attributes);
        
        if (!isset($this->setup->uri)) {
            $this->getPrinters();
            unset($this->jobs[count($this->jobs) - 1]);
            unset($this->jobs_uri[count($this->jobs_uri) - 1]);
            unset($this->status[count($this->status) - 1]);
            
            if (array_key_exists(0,$this->available_printers))
               self::setPrinterURI($this->available_printers[0]);
            else {
                trigger_error(_("_stringJob: Printer URI is not set: die"),E_USER_WARNING);
                self::_putDebug( _("_stringJob: Printer URI is not set: die\n"),3);
                self::_errorLog(" Printer URI is not set, die",2);
                return FALSE;
                }
            }
            
        if (!isset($this->setup->charset))
            self::setCharset('us-ascii');
            
        if (!isset($this->setup->language))
            self::setLanguage('en_us');

        if (!isset($this->meta->username))
            self::setUserName();
       
        $this->stringjob = chr(0x01) . chr(0x01) // 1.1  | version-number
                         . chr(0x00) . chr (0x0b) // Print-URI | operation-id
                         . $this->meta->operation_id //           request-id
                         . chr(0x01) // start operation-attributes | operation-attributes-tag
                         . $this->meta->charset
                         . $this->meta->language
                         . $this->meta->printer_uri
                         . $this->meta->username
                         . $printerattributes
                         . chr(0x03); // end-of-attributes | end-of-attributes-tag
                         
        self::_putDebug(sprintf(_("String sent to the server is:\n%s\n"), $this->stringjob));
        
        self::_putDebug(sprintf(_("Getting printer attributes of %s\n"),$this->printer_uri),2); 
            
        $this->output = $this->stringjob;
          
        $post_values = array( "Content-Type"=>"application/ipp",
                              "Data"=>$this->output);
            
        if (self::_sendHttp ($post_values,$this->paths['root']))
            if (self::_parseServerOutput())
                self::_parsePrinterAttributes(); 
        
        $this->attributes = &$this->printer_attributes;
        
        if (isset($this->serveroutput) && isset($this->serveroutput->status)) {
            
            $this->status = array_merge($this->status,array($this->serveroutput->status));
            
            if  ($this->serveroutput->status == "successfull-ok")
                self::_errorLog(sprintf(_("getting printer attributes of %s: %s"),$this->printer_uri,
                                                                        $this->serveroutput->status),3);
            else 
                self::_errorLog(sprintf(_("getting printer attributes of %s: %s"),$this->printer_uri,
                                                                        $this->serveroutput->status),1);

            return $this->serveroutput->status;
            }

            $this->status = array_merge($this->status,array("OPERATION FAILED"));
            self::_errorLog(date("Y-m-d H:i:s : ")
                        .basename($_SERVER['PHP_SELF'])
                        .sprintf(_("getting printer's attributes of %s : OPERATION FAILED"),
                                     $this->printer_uri),3);
    
    return false;
    }
    // }}}

    // {{{ getJobs ($my_jobs=true,$limit=0,$which_jobs="");
    public function getJobs($my_jobs=true,$limit=0,$which_jobs="not-completed",$subset=false) {
        
        $this->jobs = array_merge($this->jobs,array(""));
        $this->jobs_uri = array_merge($this->jobs_uri,array(""));

        self::_setOperationId();
        $this->parsed = array();
        unset($this->printer_attributes);
        
        if (!isset($this->setup->uri)) {
            $this->getPrinters();
            unset($this->jobs[count($this->jobs) - 1]);
            unset($this->jobs_uri[count($this->jobs_uri) - 1]);
            unset($this->status[count($this->status) - 1]);
            
            if (array_key_exists(0,$this->available_printers))
               self::setPrinterURI($this->available_printers[0]);
            else {
                trigger_error(_("getJobs: Printer URI is not set: die"),E_USER_WARNING);
                self::_putDebug( _("_stringJob: Printer URI is not set: die\n"),3);
                self::_errorLog("getJobs: Printer URI is not set, die",2);
                return FALSE;
                }
            }
            
        if (!isset($this->setup->charset))
            self::setCharset('us-ascii');
            
        if (!isset($this->setup->language))
            self::setLanguage('en_us');

        if (!isset($this->meta->username))
            self::setUserName();

        if ($limit) {
            $limit = self::_integerBuild($limit);
            $this->meta->limit = chr(0x21) // integer
                               . self::_giveMeStringLength('limit')
                               . 'limit'
                               . self::_giveMeStringLength($limit)
                               . $limit;
        } else
            $this->meta->limit = '';
        
        if ($which_jobs == 'completed')
                $this->meta->which_jobs = chr(0x44) // keyword
                                        . self::_giveMeStringLength('which-jobs')
                                        . 'which-jobs'
                                        . self::_giveMeStringLength($which_jobs)
                                        . $which_jobs;
        else
            $this->meta->which_jobs = "";

        if ($my_jobs)
            $this->meta->my_jobs = chr(0x22) // boolean
                                 . self::_giveMeStringLength('my-jobs')
                                 . 'my-jobs'
                                 . self::_giveMeStringLength(chr(0x01))
                                 . chr(0x01);
        else
            $this->meta->my_jobs = '';
            
        $this->stringjob = chr(0x01) . chr(0x01) // 1.1  | version-number
                         . chr(0x00) . chr (0x0A) // Get-Jobs | operation-id
                         . $this->meta->operation_id //           request-id
                         . chr(0x01) // start operation-attributes | operation-attributes-tag
                         . $this->meta->charset
                         . $this->meta->language
                         . $this->meta->printer_uri
                         . $this->meta->username
                         . $this->meta->limit
                         . $this->meta->which_jobs 
                         . $this->meta->my_jobs
                         ;
       if ($subset) {
           $this->stringjob .=
                          chr(0x44) // keyword
                         . self::_giveMeStringLength('requested-attributes')
                         . 'requested-attributes'
                         . self::_giveMeStringLength('job-uri')
                         . 'job-uri'
                         . chr(0x44) // keyword
                         . self::_giveMeStringLength('')
                         . ''
                         . self::_giveMeStringLength('job-name')
                         . 'job-name'
                         . chr(0x44) // keyword
                         . self::_giveMeStringLength('')
                         . ''
                         . self::_giveMeStringLength('job-state')
                         . 'job-state'
                         . chr(0x44) // keyword
                         . self::_giveMeStringLength('')
                         . ''
                         . self::_giveMeStringLength('job-state-reason')
                         . 'job-state-reason'
                         ;
        }
        else { # cups 1.4.4 doesn't return much of anything without this
            $this->stringjob .=
                          chr(0x44) // keyword
                         . self::_giveMeStringLength('requested-attributes')
                         . 'requested-attributes'
                         . self::_giveMeStringLength('all')
                         . 'all'
                         ;
        }
        $this->stringjob .= chr(0x03); // end-of-attributes | end-of-attributes-tag
                         
        self::_putDebug(sprintf(_("String sent to the server is:\n%s\n"), $this->stringjob));
        
        self::_putDebug(sprintf(_("getting jobs of %s\n"),$this->printer_uri),2); 
            
        $this->output = $this->stringjob;
          
        $post_values = array( "Content-Type"=>"application/ipp",
                              "Data"=>$this->output);
            
        if (self::_sendHttp ($post_values,$this->paths['jobs']))
            if (self::_parseServerOutput())
                self::_parseJobsAttributes();
                
        $this->attributes = &$this->jobs_attributes;

        
        if (isset($this->serveroutput) && isset($this->serveroutput->status)) {
            
            $this->status = array_merge($this->status,array($this->serveroutput->status));
            
            if ($this->serveroutput->status == "successfull-ok")
                self::_errorLog(sprintf(_("getting jobs of printer %s: "),$this->printer_uri)
                            .$this->serveroutput->status,3);
            else
                 self::_errorLog(sprintf(_("getting jobs of printer %s: "),$this->printer_uri)
                                             .$this->serveroutput->status,1);
                                             
            return $this->serveroutput->status;
            }    
            
        $this->status = array_merge($this->status,array("OPERATION FAILED"));
        self::_errorLog(date("Y-m-d H:i:s : ")
                        .basename($_SERVER['PHP_SELF'])
                        .sprintf(_("getting jobs of %s : OPERATION FAILED"),
                                     $this->printer_uri),3);
            
    return false;
    }
    // }}}

    // {{{ getJobAttributes ($job_uri,subset="false",$attributes_group="all");
    public function getJobAttributes($job_uri,$subset=false,$attributes_group="all") {
       
        $this->jobs = array_merge($this->jobs,array(""));
        $this->jobs_uri = array_merge($this->jobs_uri,array(""));
        
        if (!$job_uri) {
            trigger_error(_("getJobAttributes: Job URI is not set, die."));
            return FALSE;
            }
 
        self::_setOperationId();
        $this->parsed = array();
        unset($this->printer_attributes);
        
        if (!isset($this->setup->uri)) {
            $this->getPrinters();
            unset($this->jobs[count($this->jobs) - 1]);
            unset($this->jobs_uri[count($this->jobs_uri) - 1]);
            unset($this->status[count($this->status) - 1]);
            
            if (array_key_exists(0,$this->available_printers))
               self::setPrinterURI($this->available_printers[0]);
            else {
                trigger_error(_("getJobs: Printer URI is not set: die"),E_USER_WARNING);
                self::_putDebug( _("_stringJob: Printer URI is not set: die\n"),3);
                self::_errorLog("getJobs: Printer URI is not set, die",2);
                return FALSE;
                }
            }
            
        if (!isset($this->setup->charset))
            self::setCharset('us-ascii');
            
        if (!isset($this->setup->language))
            self::setLanguage('en_us');

        if (!isset($this->meta->username))
            self::setUserName();

        $this->meta->job_uri = chr(0x45) // URI
                             . self::_giveMeStringLength('job-uri')
                             . 'job-uri'
                             . self::_giveMeStringLength($job_uri)
                             . $job_uri;
           
        $this->stringjob = chr(0x01) . chr(0x01) // 1.1  | version-number
                         . chr(0x00) . chr (0x09) // Get-Job-Attributes | operation-id
                         . $this->meta->operation_id //           request-id
                         . chr(0x01) // start operation-attributes | operation-attributes-tag
                         . $this->meta->charset
                         . $this->meta->language
                         . $this->meta->job_uri
                         . $this->meta->username
                         ;
       if ($subset)
           $this->stringjob .=
                          chr(0x44) // keyword
                         . self::_giveMeStringLength('requested-attributes')
                         . 'requested-attributes'
                         . self::_giveMeStringLength('job-uri')
                         . 'job-uri'
                         . chr(0x44) // keyword
                         . self::_giveMeStringLength('')
                         . ''
                         . self::_giveMeStringLength('job-name')
                         . 'job-name'
                         . chr(0x44) // keyword
                         . self::_giveMeStringLength('')
                         . ''
                         . self::_giveMeStringLength('job-state')
                         . 'job-state'
                         . chr(0x44) // keyword
                         . self::_giveMeStringLength('')
                         . ''
                         . self::_giveMeStringLength('job-state-reason')
                         . 'job-state-reason'
                         ;
        elseif($attributes_group) {
            switch($attributes_group) {
                case 'job-template':
                    break;
                case 'job-description':
                    break;
                case 'all':
                    break;
                default:
                    trigger_error(_('not a valid attribute group: ').$attributes_group,E_USER_NOTICE);
                    $attributes_group = '';
                    break;
                }
            $this->stringjob .=
                          chr(0x44) // keyword
                         . self::_giveMeStringLength('requested-attributes')
                         . 'requested-attributes'
                         . self::_giveMeStringLength($attributes_group)
                         . $attributes_group;
            }
        $this->stringjob .= chr(0x03); // end-of-attributes | end-of-attributes-tag
                         
        self::_putDebug(sprintf(_("String sent to the server is:\n%s\n"), $this->stringjob));
        
        self::_putDebug(sprintf(_("getting jobs of %s\n"),$this->printer_uri),2); 
            
        $this->output = $this->stringjob;
          
        $post_values = array( "Content-Type"=>"application/ipp",
                              "Data"=>$this->output);
            
        if (self::_sendHttp ($post_values,$this->paths['jobs']))
            if (self::_parseServerOutput())
                self::_parseJobAttributes();
        
        $this->attributes = &$this->job_attributes;
        
        if (isset($this->serveroutput) && isset($this->serveroutput->status)) {
            
            $this->status = array_merge($this->status,array($this->serveroutput->status));
            
            if ($this->serveroutput->status == "successfull-ok")
                self::_errorLog(sprintf(_("getting job attributes for %s: "),$job_uri)
                            .$this->serveroutput->status,3);
            else
                 self::_errorLog(sprintf(_("getting job attributes for %s: "),$job_uri)
                                             .$this->serveroutput->status,1);
                                             
            return $this->serveroutput->status;
            }    
            
        $this->status = array_merge($this->status,array("OPERATION FAILED"));
        self::_errorLog(date("Y-m-d H:i:s : ")
                        .basename($_SERVER['PHP_SELF'])
                        .sprintf(_("getting jobs attributes of %s : OPERATION FAILED"),
                                     $job_uri),3);
            
    return false;
    }

    // }}}

    // {{{ getPrinters();
    public function getPrinters() {

        // placeholder for vendor extension operation (getAvailablePrinters for CUPS)
        $this->jobs = array_merge($this->jobs,array(''));
        $this->jobs_uri = array_merge($this->jobs_uri,array(''));
        $this->status = array_merge($this->status,array(''));    
    }
    // }}}    

/******************
*
* DEVELOPPEMENT FUNCTIONS
*
*******************/
 
    // {{{ generateError($error)
    public function generateError ($error) {
        switch ($error) {
            case "request_body_malformed":
                $this->error_generation->request_body_malformed = chr(0xFF);
                break;
            default:
                true;
                break;
            }
    // }}}

    // {{{ resetError ($error)
        trigger_error(sprintf(_('Setting Error %s'),$error),E_USER_NOTICE);
    }
    
    public function resetError ($error) {
        unset ($this->error_generation->$error);
        trigger_error(sprintf(_('Reset Error %s'),$error),E_USER_NOTICE);
    }
    // }}}

/******************
*
* PROTECTED FUNCTIONS
*
*******************/

// SETUP

    // {{{ _setOperationId ()
    protected function _setOperationId () {
            $prepend = '';
            $this->operation_id += 1;
            $this->meta->operation_id = self::_integerBuild($this->operation_id);
            self::_putDebug( "operation id is: ".$this->operation_id."\n",2);
    }
    // }}}
    
    // {{{ _setJobId()
    protected function _setJobId() {

        $this->meta->jobid +=1;
        $prepend = '';
        $prepend_length = 4 - strlen($this->meta->jobid);
        for ($i = 0; $i < $prepend_length ; $i++ )
            $prepend .= '0';

    return $prepend.$this->meta->jobid;
    }
    // }}}
    
    // {{{ _setJobUri ($job_uri) 
    protected function _setJobUri ($job_uri) {
       
        $this->meta->job_uri = chr(0x45) // type uri
                             . chr(0x00).chr(0x07) // name-length
                             . "job-uri"
                             //. chr(0x00).chr(strlen($job_uri))
                             . self::_giveMeStringLength($job_uri)
                             . $job_uri;
        
        self::_putDebug( "job-uri is: ".$job_uri."\n",2);
    }
    // }}}
    
// RESPONSE PARSING

    // {{{ _parsePrinterAttributes()
    protected function _parsePrinterAttributes() {

        //if (!preg_match('#successful#',$this->serveroutput->status))
        //   return false;

        $k = -1;
        for ($i = 0 ; $i < count($this->serveroutput->response) ; $i++)
            for ($j = 0 ; $j < (count($this->serveroutput->response[$i]) - 1) ; $j ++)
                if (!empty($this->serveroutput->response[$i][$j]['name'])) {
                    $k++;
                    $l = 0;
                    $this->parsed[$k]['range'] = $this->serveroutput->response[$i]['attributes'];
                    $this->parsed[$k]['name'] = $this->serveroutput->response[$i][$j]['name'];
                    $this->parsed[$k]['type'] = $this->serveroutput->response[$i][$j]['type'];
                    $this->parsed[$k][$l] = $this->serveroutput->response[$i][$j]['value'];
                } else {
                    $l ++;
                    $this->parsed[$k][$l] = $this->serveroutput->response[$i][$j]['value'];
                    }
        $this->serveroutput->response = array();
        
        $this->printer_attributes = new stdClass();
        for ($i = 0 ; $i < count($this->parsed) ; $i ++) {
                    $name = $this->parsed[$i]['name'];
                    $php_name = str_replace('-','_',$name);
                    $type = $this->parsed[$i]['type'];
                    $range = $this->parsed[$i]['range'];
                    $this->printer_attributes->$php_name = new stdClass();
                    $this->printer_attributes->$php_name->_type = $type;
                    $this->printer_attributes->$php_name->_range = $range;
                    for ($j = 0 ; $j < (count($this->parsed[$i]) - 3) ; $j ++) {
                        $value = $this->parsed[$i][$j];
                        $index = '_value'.$j;
                        $this->printer_attributes->$php_name->$index = $value;
                        }
                    }
                    
        $this->parsed = array();
                
         
    }
    // }}}

    // {{{ _parseJobsAttributes()
    protected function _parseJobsAttributes() {

        //if ($this->serveroutput->status != "successfull-ok")
        //    return false;
        
        $job = -1;
        for ($i = 0 ; $i < count($this->serveroutput->response) ; $i++) {
            if ($this->serveroutput->response[$i]['attributes'] == "job-attributes")
                $job ++;
            $k = -1; 
            for ($j = 0 ; $j < (count($this->serveroutput->response[$i]) - 1) ; $j ++)
                if (!empty($this->serveroutput->response[$i][$j]['name'])) {
                    $k++;
                    $l = 0;
                    $this->parsed[$job][$k]['range'] = $this->serveroutput->response[$i]['attributes'];
                    $this->parsed[$job][$k]['name'] = $this->serveroutput->response[$i][$j]['name'];
                    $this->parsed[$job][$k]['type'] = $this->serveroutput->response[$i][$j]['type'];
                    $this->parsed[$job][$k][$l] = $this->serveroutput->response[$i][$j]['value'];
                } else {
                    $l ++;
                    $this->parsed[$job][$k][$l] = $this->serveroutput->response[$i][$j]['value'];
                    }
            }
        
        $this->serveroutput->response = array();
        $this->jobs_attributes = new stdClass();
        for ($job_nbr = 0 ; $job_nbr <= $job ; $job_nbr ++) {
            $job_index = "job_".$job_nbr;
            $this->jobs_attributes->$job_index = new stdClass();
            for ($i = 0 ; $i < count($this->parsed[$job_nbr]) ; $i ++) {
                    $name = $this->parsed[$job_nbr][$i]['name'];
                    $php_name = str_replace('-','_',$name);
                    $type = $this->parsed[$job_nbr][$i]['type'];
                    $range = $this->parsed[$job_nbr][$i]['range'];
                    $this->jobs_attributes->$job_index->$php_name = new stdClass();
                    $this->jobs_attributes->$job_index->$php_name->_type = $type;
                    $this->jobs_attributes->$job_index->$php_name->_range = $range;
                    for ($j = 0 ; $j < (count($this->parsed[$job_nbr][$i]) - 3) ; $j ++) {
                        # This causes incorrect parsing of integer job attributes.
                        # 2010-08-16
                        # bpkroth
                        #$value = self::_interpretAttribute($name,$type,$this->parsed[$job_nbr][$i][$j]);
                        $value = $this->parsed[$job_nbr][$i][$j];
                        $index = '_value'.$j;
                        $this->jobs_attributes->$job_index->$php_name->$index = $value;
                        }
                    }
            }
            
        $this->parsed = array();
                
         
    }
    // }}}
    
    // {{{ _readAttribute($attributes_type,$ji,&$collection=false)
    protected function _readAttribute($attributes_type) {
        
            $tag = ord($this->serveroutput->body[$this->_parsing->offset]);
            
            $this->_parsing->offset += 1;
            $j = $this->index;
            
            $tag = self::_readTag($tag);

            switch ($tag) {
                 case "begCollection": //RFC3382 (BLIND CODE)
                    if ($this->end_collection)
                        $this->index --;
                    $this->end_collection = false;
                    $this->serveroutput->response[$attributes_type][$j]['type'] = "collection";
                    self::_putDebug( "tag is: begCollection\n");
                    self::_readAttributeName ($attributes_type,$j);
                    if (!$this->serveroutput->response[$attributes_type][$j]['name']) { // it is a multi-valued collection
                        $this->collection_depth ++;
                        $this->index --;
                        $this->collection_nbr[$this->collection_depth] ++;
                    } else {
                        $this->collection_depth ++;
                        if ($this->collection_depth == 0)
                            $this->collection = (object) 'collection';
                        if (array_key_exists($this->collection_depth,$this->collection_nbr))
                            $this->collection_nbr[$this->collection_depth] ++;
                        else
                            $this->collection_nbr[$this->collection_depth] = 0;
                        unset($this->end_collection);
                        
                        }
                    self::_readValue ("begCollection",$attributes_type,$j);
                    break;
                 case "endCollection": //RFC3382 (BLIND CODE)
                    $this->serveroutput->response[$attributes_type][$j]['type'] = "collection";
                    self::_putDebug( "tag is: endCollection\n");
                    self::_readAttributeName ($attributes_type,$j,0);
                    self::_readValue ('name',$attributes_type,$j,0);
                    $this->collection_depth --;
                    $this->collection_key[$this->collection_depth] = 0;
                    $this->end_collection = true;
                    break;
                 case "memberAttrName": // RFC3382 (BLIND CODE)
                    $this->serveroutput->response[$attributes_type][$j]['type'] = "memberAttrName";
                    $this->index -- ;
                    self::_putDebug( "tag is: memberAttrName\n");
                    self::_readCollection ($attributes_type,$j);
                    break;
 
                default:
                    $this->collection_depth = -1;
                    $this->collection_key = array();
                    $this->collection_nbr = array();
                    $this->serveroutput->response[$attributes_type][$j]['type'] = $tag;
                    self::_putDebug( "tag is: $tag\n");
                    $attribute_name = self::_readAttributeName ($attributes_type,$j);
                    if (!$attribute_name)
                        $attribute_name = $this->attribute_name;
                    else
                        $this->attribute_name = $attribute_name;
                    $value = self::_readValue ($tag,$attributes_type,$j);
                    $this->serveroutput->response[$attributes_type][$j]['value'] = 
                        self::_interpretAttribute($attribute_name,$tag,$this->serveroutput->response[$attributes_type][$j]['value']);
                    break;
                
            }
    return;
    }
    // }}}

    // {{{  _readTag($tag)
    protected function _readTag($tag) {

            switch ($tag) {
                case 0x10:
                    $tag = "unsupported";
                    break;
                case 0x11:
                    $tag = "reserved for 'default'";
                    break;
                case 0x12:
                    $tag = "unknown";
                    break;
                case 0x13:
                    $tag = "no-value";
                    break;
                case 0x15: // RFC 3380
                    $tag = "not-settable";
                    break;
                case 0x16: // RFC 3380
                    $tag = "delete-attribute";
                    break;
                case 0x17: // RFC 3380
                    $tag = "admin-define";
                    break;
                case 0x20:
                    $tag = "IETF reserved (generic integer)";
                    break;
                case 0x21:
                    $tag = "integer";
                    break;
                case 0x22:
                    $tag = "boolean";
                    break;
                case 0x23:
                    $tag = "enum";
                    break;
                case 0x30:
                    $tag = "octetString";
                    break;
                case 0x31:
                    $tag = "datetime";
                    break;
                 case 0x32:
                    $tag = "resolution";
                    break;
                 case 0x33:
                    $tag = "rangeOfInteger";
                    break;
                 case 0x34: //RFC3382 (BLIND CODE)
                    $tag = "begCollection";
                    break;
                 case 0x35:
                    $tag = "textWithLanguage";
                    break;
                 case 0x36:
                    $tag = "nameWithLanguage";
                    break;
                 case 0x37: //RFC3382 (BLIND CODE)
                    $tag = "endCollection";
                    break;
                 case 0x40:
                    $tag = "IETF reserved text string";
                    break;
                 case 0x41:
                    $tag = "textWithoutLanguage";
                    break;
                 case 0x42:
                    $tag = "nameWithoutLanguage";
                    break;
                 case 0x43:
                    $tag = "IETF reserved for future";
                    break;
                 case 0x44:
                    $tag = "keyword";
                    break;
                 case 0x45:
                    $tag = "uri";
                    break;
                 case 0x46:
                    $tag = "uriScheme";
                    break;
                 case 0x47:
                    $tag = "charset";
                    break;
                 case 0x48:
                    $tag = "naturalLanguage";
                    break;
                 case 0x49:
                    $tag = "mimeMediaType";
                    break;
                 case 0x4A: // RFC3382 (BLIND CODE)
                    $tag = "memberAttrName";
                    break;
                  case 0x7F:
                    $tag = "extended type";
                    break;
                 default:
                 
                    if ($tag >= 0x14 && $tag < 0x15 && $tag > 0x17 && $tag <= 0x1f) 
                        $tag = "out-of-band";
                    elseif (0x24 <= $tag && $tag <= 0x2f) 
                        $tag = "new integer type";
                    elseif (0x38 <= $tag && $tag <= 0x3F) 
                        $tag = "new octet-stream type";
                    elseif (0x4B <= $tag && $tag <= 0x5F) 
                        $tag = "new character string type";
                    elseif ((0x60 <= $tag && $tag < 0x7f) || $tag >= 0x80 )
                        $tag = "IETF reserved for future";
                    else
                        $tag = sprintf("UNKNOWN: 0x%x (%u)",$tag,$tag);
                        
                    break;                                                            
                }
    return $tag; 
    }
    // }}}

    // {{{ _readCollection($attributes_type,$j,&$collection)
    protected function _readCollection($attributes_type,$j) {
       
        $name_length = ord($this->serveroutput->body[$this->_parsing->offset]) *  256
                     +  ord($this->serveroutput->body[$this->_parsing->offset + 1]);
        
        $this->_parsing->offset += 2;
        
        self::_putDebug( "Collection name_length ". $name_length ."\n");
        
        $name = '';
        for ($i = 0; $i < $name_length; $i++) {
            $name .= $this->serveroutput->body[$this->_parsing->offset];
            $this->_parsing->offset += 1;
            if ($this->_parsing->offset > strlen($this->serveroutput->body))
                return;
            }
        
        $collection_name = $name;
        
        $name_length = ord($this->serveroutput->body[$this->_parsing->offset]) *  256
                     +  ord($this->serveroutput->body[$this->_parsing->offset + 1]);
        $this->_parsing->offset += 2;
        
        self::_putDebug( "Attribute name_length ". $name_length ."\n");
        
        $name = '';
        for ($i = 0; $i < $name_length; $i++) {
            $name .= $this->serveroutput->body[$this->_parsing->offset];
            $this->_parsing->offset += 1;
            if ($this->_parsing->offset > strlen($this->serveroutput->body))
                return;
            }
        
        $attribute_name = $name;
        if ($attribute_name == "") {
            $attribute_name = $this->last_attribute_name;
            $this->collection_key[$this->collection_depth] ++;
        } else {
            $this->collection_key[$this->collection_depth] = 0;
        }
        $this->last_attribute_name = $attribute_name;
        
        self::_putDebug( "Attribute name ".$name."\n");
        
        $tag = self::_readTag(ord($this->serveroutput->body[$this->_parsing->offset]));
        $this->_parsing->offset ++;
        
        $type = $tag;
        
        $name_length = ord($this->serveroutput->body[$this->_parsing->offset]) *  256
                     +  ord($this->serveroutput->body[$this->_parsing->offset + 1]);
        $this->_parsing->offset += 2;
        
        self::_putDebug( "Collection2 name_length ". $name_length ."\n");
        
        $name = '';
        for ($i = 0; $i < $name_length; $i++) {
            $name .= $this->serveroutput->body[$this->_parsing->offset];
            $this->_parsing->offset += 1;
            if ($this->_parsing->offset > strlen($this->serveroutput->body))
                return;
            }
        
        $collection_value = $name;
        $value_length = ord($this->serveroutput->body[$this->_parsing->offset]) *  256
                      +  ord($this->serveroutput->body[$this->_parsing->offset + 1]);
        
        self::_putDebug( "Collection value_length ".$this->serveroutput->body[ $this->_parsing->offset]
                                       . $this->serveroutput->body[$this->_parsing->offset + 1]
                                       .": "
                                       . $value_length
                                       . " ");
        
        $this->_parsing->offset += 2;
        
        $value = '';
        for ($i = 0; $i < $value_length; $i++) {
            
            if ($this->_parsing->offset >= strlen($this->serveroutput->body))
                return;
            $value .= $this->serveroutput->body[$this->_parsing->offset];
            $this->_parsing->offset += 1;
            
            }
        
        $object = &$this->collection;
        for ($i = 0 ; $i <= $this->collection_depth ; $i ++) {
            $indice = "_indice".$this->collection_nbr[$i];
            if (!isset($object->$indice))
                $object->$indice = (object) 'indice';
            $object = &$object->$indice;
            }
         
        $value_key = "_value".$this->collection_key[$this->collection_depth];
        $col_name_key = "_collection_name".$this->collection_key[$this->collection_depth];
        $col_val_key = "_collection_value".$this->collection_key[$this->collection_depth];
        
        $attribute_value = self::_interpretAttribute($attribute_name,$tag,$value);
        $attribute_name = str_replace('-','_',$attribute_name);
        
        
        self::_putDebug( sprintf("Value: %s\n",$value));
        $object->$attribute_name->_type = $type;
        $object->$attribute_name->$value_key = $attribute_value;
        $object->$attribute_name->$col_name_key = $collection_name;
        $object->$attribute_name->$col_val_key = $collection_value;
        
    $this->serveroutput->response[$attributes_type][$j]['value'] = $this->collection;
    }
    // }}}
    
    // {{{ _readAttributeName ($attributes_type,$j)
    protected function _readAttributeName ($attributes_type,$j,$write=1) {

        $name_length = ord($this->serveroutput->body[ $this->_parsing->offset]) *  256
                     +  ord($this->serveroutput->body[$this->_parsing->offset + 1]);
        $this->_parsing->offset += 2;
        
        self::_putDebug( "name_length ". $name_length ."\n");
        
        $name = '';
        for ($i = 0; $i < $name_length; $i++) {
            if ($this->_parsing->offset >= strlen($this->serveroutput->body))
                return;
            $name .= $this->serveroutput->body[$this->_parsing->offset];
            $this->_parsing->offset += 1;
            }
        
        if($write)
        $this->serveroutput->response[$attributes_type][$j]['name'] = $name;

        self::_putDebug( "name " . $name . "\n");
    
    return $name;   
    }
    // }}}

    // {{{ _readValue ($type,$attributes_type,$j)
    protected function _readValue ($type,$attributes_type,$j,$write=1) {

        $value_length = ord($this->serveroutput->body[$this->_parsing->offset]) *  256
                      +  ord($this->serveroutput->body[$this->_parsing->offset + 1]);
        
        self::_putDebug( "value_length ".$this->serveroutput->body[ $this->_parsing->offset]
                                       . $this->serveroutput->body[$this->_parsing->offset + 1]
                                       .": "
                                       . $value_length
                                       . " ");
        
        $this->_parsing->offset += 2;
        
        $value = '';
        for ($i = 0; $i < $value_length; $i++) {
            
            if ($this->_parsing->offset >= strlen($this->serveroutput->body))
                return;
            $value .= $this->serveroutput->body[$this->_parsing->offset];
            $this->_parsing->offset += 1;
            
       …