root / pkpgcounter / trunk / pkpgpdls / lidil.py @ 485

#! /usr/bin/env python
# -*- coding: ISO-8859-15 -*-
#
# pkpgcounter : a generic Page Description Language parser
#
# (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet <alet@librelogiciel.com>
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# 
# This program 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 General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# $Id$
#

"""This modules implements a page counter for HP LIDIL format.

   Documentation used : 
   
        hplip-2.7.10/prnt/ldl.py
        hplip-2.7.10/prnt/hpijs/ldlencap.h
"""

import sys
import os
import mmap
from struct import unpack

import pdlparser

# Packet types taken from hplip-2.7.10/prnt/ldl.py
PACKET_TYPE_COMMAND = 0
PACKET_TYPE_DISABLE_PACING = 1
PACKET_TYPE_ENABLE_PACING = 2
PACKET_TYPE_RESUME_NORMAL_OPERATION = 3
PACKET_TYPE_DISABLE_RESPONSES = 4
PACKET_TYPE_ENABLE_RESPONSES = 5
PACKET_TYPE_RESET_LIDIL = 6
PACKET_TYPE_SYNC = 7
PACKET_TYPE_SYNC_COMPLETE = 8

# Command codes we are interested in.
LDL_LOAD_PAGE = 1
LDL_EJECT_PAGE = 2

class Parser(pdlparser.PDLParser) :
    """A parser for HP LIDIL documents."""
    def isValid(self) :    
        """Returns True if data is LIDIL, else False."""
        # Beginning Of File marker is a Sync packet, followed with
        # a Sync Complete packet followed with a Reset packet.
        # We just look at the start of the Sync packet for simplicity's sake.
        BOFMarker = "$\x01\x00\x00\x07"
        # End Of File marker is a Sync Complete packet followed
        # with a Reset packet. We ignore the preceding Sync packet
        # for simplicity's sake.
        EOFMarker = "$\x00\x10\x00\x08\x00\x00\x00\x00\x00\xff\xff\xff\xff\xff$$\x00\x10\x00\x06\x00\x00\x00\x00\x00\xff\xff\xff\xff\xff$" 
        if self.firstblock.startswith(BOFMarker) \
           and self.lastblock.endswith(EOFMarker) :
            self.logdebug("DEBUG: Input file is in the Hewlett-Packard LIDIL format.")
            return True
        else :    
            return False
        
    def getJobSize(self) :
        """Computes the number of pages in a HP LIDIL document."""
        pagecount = 0
        infileno = self.infile.fileno()
        minfile = mmap.mmap(infileno, os.fstat(infileno)[6], prot=mmap.PROT_READ, flags=mmap.MAP_SHARED)
        pos = 0
        try :
            try :
                while 1 :
                    if minfile[pos] != "$" :    # Frame Sync
                        raise pdlparser.PDLParserError, "This file doesn't seem to be valid Hewlett-Packard LIDIL datas"
                    try :    
                        (framesync,     
                         cmdlength,
                         dummy,
                         packettype,
                         commandnumber,
                         referencenumber,
                         datalength) = unpack(">BHBBBHH", minfile[pos:pos+10])
                    except struct.error :    
                        raise pdlparser.PDLParserError, "This file doesn't seem to be valid Hewlett-Packard LIDIL datas"
                    if (packettype == PACKET_TYPE_COMMAND) \
                        and (commandnumber == LDL_EJECT_PAGE) :
                        pagecount += 1
                    pos += (cmdlength + datalength)
            except IndexError : # EOF ?
                pass 
        finally :        
            minfile.close()
        return pagecount

if __name__ == "__main__" :    
    pdlparser.test(Parser)