This file is indexed.

/etc/gnuspool/cupspy/cups.py is in gnuspool-cupspy 1.7ubuntu1.

This file is owned by root:root, with mode 0o755.

The actual contents of the file can be viewed below.

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
#! /usr/bin/python
#
# Copyright (C) 2009  Free Software Foundation
#
# 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, 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.

# Originally written by John Collins <jmc@xisl.com>.

import filebuf, ipp, conf, subprocess, sys, os, stat, socket, select, threading, re, time, signal, syslog, errno

# Get us a job id in case gspl-pr doesn't give one

Next_jobid = os.getpid()
Jobid_lock = threading.Lock()

Var_run = "/var/run/cups"
Procid_file = "cupsd.pid"

# Thread-safe get job ID

def get_next_jobid():
    """Get next job id"""
    global Next_jobid
    Jobid_lock.acquire()
    result = Next_jobid
    Next_jobid += 1
    Jobid_lock.release()
    return result

Pending_jobs = dict()

class pend_job:
    """Hold details of pending job"""

    def __init__(self, p, u, t, c):
	global Pending_jobs
	self.jobnum = get_next_jobid()
        self.pname = p
        self.uname = u
        self.title = t
        self.copies = c
        Pending_jobs[self.jobnum] = self

# Set up default attribute values

default_attr_values = {'attributes-charset': 'utf-8',
                       'attributes-natural-language': 'en-gb',
                       'copies': 1,
                       'job-name': 'No Title'}

# List of attributes to include in description

printer_description_atts = ["charset-configured",
                            "charset-supported",
                            "color-supported",
                            "compression-supported",
                            "document-format-default",
                            "document-format-supported",
                            "generated-natural-language-supported",
                            "ipp-versions-supported",
                            "job-impressions-supported",
                            "job-k-octets-supported",
                            "job-media-sheets-supported",
                            "multiple-document-jobs-supported",
                            "multiple-operation-time-out",
                            "natural-language-configured",
                            "notify-attributes-supported",
                            "notify-lease-duration-default",
                            "notify-lease-duration-supported",
                            "notify-max-events-supported",
                            "notify-events-default",
                            "notify-events-supported",
                            "notify-pull-method-supported",
                            "notify-schemes-supported",
                            "operations-supported",
                            "pages-per-minute",
                            "pages-per-minute-color",
                            "pdl-override-supported",
                            "printer-alert",
                            "printer-alert-description",
                            "printer-current-time",
                            "printer-driver-installer",
                            "printer-info",
                            "printer-is-accepting-jobs",
                            "printer-location",
                            "printer-make-and-model",
                            "printer-message-from-operator",
                            "printer-more-info",
                            "printer-more-info-manufacturer",
                            "printer-name",
                            "printer-state",
                            "printer-state-message",
                            "printer-state-reasons",
                            "printer-up-time",
                            "printer-uri-supported",
                            "queued-job-count",
                            "reference-uri-schemes-supported",
                            "uri-authentication-supported",
                            "uri-security-supported"]

# List of attributes if none asked

printer_default_atts = ["copies-default",
                        "document-format-default",
                        "finishings-default",
                        "job-hold-until-default",
                        "job-priority-default",
                        "job-sheets-default",
                        "media-default",
                        "number-up-default",
                        "orientation-requested-default",
                        "sides-default"]

# Parse config file
# Use argument if one given, otherwise look for "cupspy.conf"
try:
    Config_data = conf.Conf()
    Cfile = 'cupspy.conf'
    if len(sys.argv) > 1:
        Cfile = sys.argv[1]
    Config_data.parse_conf_file(Cfile)
except conf.ConfError as msg:
    sys.exit(msg.args[0])

# Now for the meat of the stuff

class CupsError(Exception):
    def __init__(self, code, msg):
        Exception.__init__(self, msg)
        self.codename = code

# Util routines

def copy_or_default(req, name, blank_def = False):
    """Copy field from request or supply default"""
    val = req.find_attribute(name)
    if val:
        res = val.get_value()
        if blank_def:
            res = res.strip()
            if len(res) == 0: res = default_attr_values[name]           
    else:
        res = default_attr_values[name]
    return  res

def set_copy_or_default(req, val, name):
    """Initialise variable with copy or default"""
    val.setnamevalues(name, copy_or_default(req, name))
    return  val

def opgrp_hdr(req):
    """Return a OPERATION group with standard header fields set mostly from request"""
    opgrp = ipp.ippgroup(ipp.IPP_TAG_OPERATION)
    charset = ipp.ippvalue(ipp.IPP_TAG_CHARSET)
    opgrp.setvalue(set_copy_or_default(req, charset, 'attributes-charset'))
    lang = ipp.ippvalue(ipp.IPP_TAG_LANGUAGE)
    opgrp.setvalue(set_copy_or_default(req, lang, 'attributes-natural-language'))
    return opgrp

# Report op done OK (mostly after we haven't done anything)

def ipp_ok(req):
    """Report that everything went OK with IPP request
(Even if nothing was done)"""
    syslog.syslog(syslog.LOG_NOTICE, "No-op OK response to op %s" % ipp.op_to_name[req.statuscode])
    response = ipp.ipp()
    response.setrespcode(ipp.IPP_OK, req.id)
    response.pushvalue(opgrp_hdr(req))
    return  response.generate()

# Report status message back to caller

def ipp_status(req, code, msg):
    """Deliver a status message back to sender"""
    syslog.syslog(syslog.LOG_WARNING, "Op code %s returning result %s - %s" % (ipp.op_to_name[req.statuscode], code, msg))
    response = ipp.ipp()
    response.setrespcode(code, req.id)  # If code is a string it gets converted
    opgrp = opgrp_hdr(req)
    msgv = ipp.ippvalue(ipp.IPP_TAG_TEXT)
    msgv.setnamevalues('status-message', msg)
    opgrp.setvalue(msgv)
    response.pushvalue(opgrp)
    return  response.generate()

# Grab various fields from requests

def get_pname_from_uri(req):
    """Extract printer name from uri"""

    pname = req.find_attribute('printer-uri')
    if not pname:
        raise CupsError('IPP_BAD_REQUEST', 'Missing required printer-uri')

    # Get the actual string
    # Strip off the URI stuff to get the printer name

    pname = pname.get_value()
    m = re.match(".*/(.*)", pname)
    if not m:
        raise CupsError('IPP_BAD_REQUEST', 'Cannot determine printer name from URI')
    pname = m.group(1)

    if pname not in Config_data.printers:
        raise CupsError('IPP_NOT_FOUND', 'The printer ' + pname + ' was not found')
    return pname

def get_req_user_name(req):
    """Extract requesting user name"""

    user = req.find_attribute('requesting-user-name')
    if not user:
	raise CupsError('IPP_BAD_REQUEST', 'No requesting user')
    user = user.get_value()
    return user

# The following operations are "done" by just returning OK
# We might want to expand them to log that they have been attempted

def validate_job(req):
    return ipp_ok(req)
def get_jobs(req):
    return ipp_ok(req)
def hold_job(req):
    return ipp_ok(req)
def release_job(req):
    return ipp_ok(req)
def restart_job(req):
    return ipp_ok(req)
def pause_printer(req):
    return ipp_ok(req)
def resume_printer(req):
    return ipp_ok(req)
def purge_jobs(req):
    return ipp_ok(req)
def set_printer_attributes(req):
    return ipp_ok(req)
def set_job_attributes(req):
    return ipp_ok(req)
def create_printer_subscription(req):
    return  ipp_ok(req)
def create_job_subscription(req):
    return  ipp_ok(req)
def renew_subscription(req):
    return  ipp_ok(req)
def cancel_subscription(req):
    return  ipp_ok(req)
def enable_printer(req):
    return  ipp_ok(req)
def disable_printer(req):
    return  ipp_ok(req)
def pause_printer_after_current_job(req):
    return  ipp_ok(req)
def hold_new_jobs(req):
    return  ipp_ok(req)
def release_held_new_jobs(req):
    return  ipp_ok(req)
def deactivate_printer(req):
    return ipp_ok(req)
def activate_printer(req):
    return ipp_ok(req)
def restart_printer(req):
    return ipp_ok(req)
def shutdown_printer(req):
    return ipp_ok(req)
def startup_printer(req):
    return ipp_ok(req)
def reprocess_job(req):
    return ipp_ok(req)
def cancel_current_job(req):
    return ipp_ok(req)
def suspend_current_job(req):
    return ipp_ok(req)
def resume_job(req):
    return ipp_ok(req)
def promote_job(req):
    return ipp_ok(req)
def schedule_job_after(req):
    return ipp_ok(req)
def private(req):
    return ipp_ok(req)
def add_modify_printer(req):
    return ipp_ok(req)
def delete_printer(req):
    return ipp_ok(req)
def get_classes(req):
    return ipp_ok(req)
def add_modify_class(req):
    return ipp_ok(req)
def delete_class(req):
    return ipp_ok(req)
def accept_jobs(req):
    return ipp_ok(req)
def reject_jobs(req):
    return ipp_ok(req)
def set_default(req):
    return ipp_ok(req)
def move_job(req):
    return ipp_ok(req)
def authenticate_job(req):
    return ipp_ok(req)
# Get notifications seems to be required in some cases
def get_notifications(req):
    return ipp_ok(req)

# The next operations we return some kind of error message
# to tell the client we didn't do it.

def send_uri(req):
    return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'send uri not implemented')
def get_job_attributes(req):
    return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'get job attributes uri not implemented')
def get_printer_supported_values(req):
    return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'get printer supported values not implemented')
def get_subscription_attributes(req):
    return  ipp_status(req, 'IPP_NOT_FOUND', 'Invalid notify-subscription-id')
def get_subscriptions(req):
    return  ipp_status(req, 'IPP_NOT_FOUND', 'No subscriptions found')
def send_notifications(req):
    return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'send notifications not implemented')
def get_print_support_files(req):
    return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'get print support files not implemented')
def get_devices(req):
    return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'cups-driverd failed to execute')
def get_ppds(req):
    return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'cups-driverd failed to execute')
def get_ppd(req):
    return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'cups-driverd failed to execute')

# This is where we actually have to do something for our money.
# First lets do the things with printers

################################################################################

def expand_multi_attributes(val):
    """Expand multiple attribute names

Currently these are printer-description and printer-defaults"""

    reslist = []
    for v in val.value:
        n = v[1]
        if n == "printer-description":
            for item in printer_description_atts:
                reslist.append(item)
        elif n == "printer-defaults":
            for item in printer_default_atts:
                reslist.append(item)
        else:
            reslist.append(n)
    return reslist

# Get printers gets us a list of printers.

def get_printers(req):
    """Get the list of printers and requested attributes"""

    # Get the list of requested attributes from the request
    req_al = req.find_attribute('requested-attributes')
    if not req_al:
        return  ipp_status(req, 'IPP_BAD_REQUEST', 'No requested-attributes')

    try:
        # Just get the requested attributes strings
        req_al = expand_multi_attributes(req_al)

        # Now get the list of available printers
        ptr_list = Config_data.list_printers()

        # Set up response

        response = ipp.ipp()
        response.setrespcode(ipp.IPP_OK, req.id)
        response.pushvalue(opgrp_hdr(req))

        for ptr in ptr_list:
            ptrgrp = ipp.ippgroup(ipp.IPP_TAG_PRINTER)
            ptratts = Config_data.get_config(ptr, req_al)
            for attitem in ptratts:
                name, typenum, attlist = attitem
                val = ipp.ippvalue(typenum)
                val.setnamevalues(name, attlist)
                ptrgrp.setvalue(val)
            response.pushvalue(ptrgrp)
        return  response.generate()

    except ValueError:
        return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'Error in get_printers()')

################################################################################

def get_ptr_attributes(req, pname, al):
    """Get given attributes for given printer"""

    # Set up response

    response = ipp.ipp()
    response.setrespcode(ipp.IPP_OK, req.id)
    response.pushvalue(opgrp_hdr(req))

    # Printer group stuff

    ptrgrp = ipp.ippgroup(ipp.IPP_TAG_PRINTER)
    ptratts = Config_data.get_config(pname, al)

    # Add each attribute

    for attitem in ptratts:
        name, typenum, attlist = attitem
        val = ipp.ippvalue(typenum)
        val.setnamevalues(name, attlist)
        ptrgrp.setvalue(val)

    response.pushvalue(ptrgrp)
    return  response.generate()

def get_printer_attributes(req):
    """Get_printer_attributes request"""
    try:
        pname = get_pname_from_uri(req)
    except CupsError as err:
        return  ipp_status(req, err.codename, err.args[0])

    # Get the list of requested attributes from the request
    req_al = req.find_attribute('requested-attributes')
    if not req_al:
        return  ipp_status(req, 'IPP_BAD_REQUEST', 'No requested-attributes')

    try:
        return  get_ptr_attributes(req, pname, expand_multi_attributes(req_al))
    except:
        return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'Error in get_printers()')

def get_default(req):
    """Get default printer and attributes"""
    try:
        pname = Config_data.default_printer()
        return  get_ptr_attributes(req, pname, Config_data.get_attnames(pname))
    except:
        return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'Error in get_default()')

def created_job_ok(req, pname, jobnum):
    """Return response that job was created OK"""

    response = ipp.ipp()
    response.setrespcode(ipp.IPP_OK, req.id)
    opgrp = opgrp_hdr(req)
    msg = ipp.ippvalue(ipp.IPP_TAG_TEXT)
    msg.setnamevalues('status-message', 'successful-ok')
    opgrp.setvalue(msg)
    response.pushvalue(opgrp)

    jobgrp = ipp.ippgroup(ipp.IPP_TAG_JOB)
    idval = ipp.ippvalue(ipp.IPP_TAG_INTEGER)
    idval.setnamevalues('job-id', jobnum)
    jobgrp.setvalue(idval)
    iduri = "ipp://%s/%s/%d" % (socket.gethostname(), pname, jobnum)
    idval = ipp.ippvalue(ipp.IPP_TAG_URI)
    idval.setnamevalues('job-uri', iduri)
    jobgrp.setvalue(idval)
    jobstat = ipp.ippvalue(ipp.IPP_TAG_ENUM)
    jobstat.setnamevalues('job-state', ipp.IPP_JOB_PROCESSING)
    jobgrp.setvalue(jobstat)
    response.pushvalue(jobgrp)
    return response.generate()

class print_err(Exception):
    """Throw me if print error happens"""

    def __init__(self, c, ste, *args):
        Exception.__init__(self, *args)
        self.code = c
        self.stderr = ste

def process_print(req, pname, copies, title, user):
    """Perform the operation to do the print and return the job id.

Throw a print_error if something goes wrong"""

    command = Config_data.print_command(pname, copies=copies, title=title, user=user)
    if command is None:
        raise print_err('No print command for ' + pname)

    outf = subprocess.Popen(command, shell=True, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
    pl = outf.poll()
    if pl:
        (sto, ste) = outf.communicate()
        raise print_err(pl, ste)

    # Send the data

    sti = outf.stdin
    while 1:
        # If we get some kind of reception error do the best we can
        try:
            b = req.filb.getrem()
        except:
            outf.terminate()
            (sto, ste) = outf.communicate()
            raise print_err(256, 'Input error on socket')

        # End of data is signified by zero length
        # Other errors raise filebufEOF

        if  len(b) == 0:
            break
        try:
            sti.write(b)
        except IOError as err:
            if err.args[0] == errno.EPIPE:
                raise print_err(err.args[0], "Is spooler running")
            else:
                msg = "Pipe IO Error: " + err.args[1] + "(" + err.args[0] + ")"
                raise print_err(err.args[0], msg)

        # Check it's still running

        pl = outf.poll()
        if  pl:
            (sto, ste) = outf.communicate()
            raise print_err(pl, ste)

    # Check we didn't get error message

    (sto, ste) = outf.communicate()
    pl = outf.wait()
    if pl:
        raise print_err(pl, ste)

    # Look for job id on std error and if present use it
    # Otherwise generate

    if len(ste) != 0:
        m = re.search("(\d+)", ste)
        if m:
            jobid = int(m.group(1))
        else:
            jobid = get_next_jobid()
    else:
        jobid = get_next_jobid()

    return jobid


def print_error(req, pname, code, ste):
    """Generate return code from print"""

    msg = "%s gave exit code %d" % (pname, code)
    if len(ste) != 0:
            msg += " - " + ste
    return ipp_status(req, 'IPP_NOT_POSSIBLE', msg)

def print_job(req):
    """Actually print a job"""
    # Get printer name
    try:
        pname = get_pname_from_uri(req)
	uname = get_req_user_name(req)
    except CupsError as err:
        return  ipp_status(req, err.codename, err.args[0])

    title = copy_or_default(req, 'job-name', True)
    copies = copy_or_default(req, 'copies')

    try:
        jobid = process_print(req, pname, copies, title, uname)
    except print_err as err:
        return print_error(req, pname, err.code, err.stderr)
    return created_job_ok(req, pname, jobid)

def extract_jobid(reqop):
    """Extract job id from a request (send-document or cancel job)"""
    # Spec says it might be given as a URI or as a job number (and printer name which we don't need)
    jobid = reqop.find_attribute('job-id')
    if jobid:
        jobid = jobid.get_value()
    else:
        juri = reqop.find_attribute('job-uri')
        if not juri:
            raise CupsError('IPP_BAD_REQUEST', 'Missing required job-id or job-uri')
        m = re.match("ipp://.*/.*/(\d+)", juri.get_value())
        if not m:
            raise CupsError('IPP_BAD_REQUEST', 'Invalid format job-uri ' + juri)
        jobid = m.group(1)
    # Convert jobid to numeric and look up
    try:
        jobid = int(jobid)
    except ValueError:
        raise CupsError('IPP_BAD_REQUEST', 'Invalid non-integer jobid ' + jobid)
    return jobid

# We believe that these don't happen

def print_uri(req):
    """Dont do print_uri as it doesnt seem to be used"""
    return  ipp_status(req, 'IPP_INTERNAL_ERROR', 'print_uri not implemented')

def create_job(req):
    """Create job routine now has to be implemented"""
    # Get printer name
    try:
        pname = get_pname_from_uri(req)
	uname = get_req_user_name(req)
    except CupsError as err:
        return  ipp_status(req, err.codename, err.args[0])

    pj = pend_job(pname, uname, copy_or_default(req, 'job-name', True), copy_or_default(req, 'copies'))
    return created_job_ok(req, pname, pj.jobnum)

def send_document(req):
    """Send document to pending job created by create job"""

    # Find out the job number this is associated with

    reqop = req.values[0]
    jobid = extract_jobid(reqop)
    if jobid not in Pending_jobs:
        raise CupsError('IPP_NOT_FOUND', 'Job id not found in send-doc ' + str(jobid))
    pj = Pending_jobs[jobid]

    # If last document set, delete from pending

    lastdoc = reqop.find_attribute('last-document')
    if not lastdoc:
        raise CupsError('IPP_BAD_REQUEST', 'No last-doc attribute')
    if lastdoc.get_value():
        del Pending_jobs[jobid]
    try:
        process_print(req, pj.pname, pj.copies, pj.title, pj.uname)
    except print_err as err:
        return print_error(req, pj.pname, err.code, err.stderr)
    return created_job_ok(req, pj.pname, jobid)

def cancel_job(req):
    """Cancel job - dont worry if not pending"""
    reqop = req.values[0]
    jobid = extract_jobid(reqop)
    if jobid in Pending_jobs:
        del Pending_jobs[jobid]
    return ipp_ok(req)

# Lookup for operations

functab = dict(IPP_PRINT_JOB=print_job,
               IPP_PRINT_URI=print_uri,
               IPP_VALIDATE_JOB=validate_job,
               IPP_CREATE_JOB=create_job,
               IPP_SEND_DOCUMENT=send_document,
               IPP_SEND_URI=send_uri,
               IPP_CANCEL_JOB=cancel_job,
               IPP_GET_JOB_ATTRIBUTES=get_job_attributes,
               IPP_GET_JOBS=get_jobs,
               IPP_GET_PRINTER_ATTRIBUTES=get_printer_attributes,
               IPP_HOLD_JOB=hold_job,
               IPP_RELEASE_JOB=release_job,
               IPP_RESTART_JOB=restart_job,
               IPP_PAUSE_PRINTER=pause_printer,
               IPP_RESUME_PRINTER=resume_printer,
               IPP_PURGE_JOBS=purge_jobs,
               IPP_SET_PRINTER_ATTRIBUTES=set_printer_attributes,
               IPP_SET_JOB_ATTRIBUTES=set_job_attributes,
               IPP_GET_PRINTER_SUPPORTED_VALUES=get_printer_supported_values,
               IPP_CREATE_PRINTER_SUBSCRIPTION=create_printer_subscription,
               IPP_CREATE_JOB_SUBSCRIPTION=create_job_subscription,
               IPP_GET_SUBSCRIPTION_ATTRIBUTES=get_subscription_attributes,
               IPP_GET_SUBSCRIPTIONS=get_subscriptions,
               IPP_RENEW_SUBSCRIPTION=renew_subscription,
               IPP_CANCEL_SUBSCRIPTION=cancel_subscription,
               IPP_GET_NOTIFICATIONS=get_notifications,
               IPP_SEND_NOTIFICATIONS=send_notifications,
               IPP_GET_PRINT_SUPPORT_FILES=get_print_support_files,
               IPP_ENABLE_PRINTER=enable_printer,
               IPP_DISABLE_PRINTER=disable_printer,
               IPP_PAUSE_PRINTER_AFTER_CURRENT_JOB=pause_printer_after_current_job,
               IPP_HOLD_NEW_JOBS=hold_new_jobs,
               IPP_RELEASE_HELD_NEW_JOBS=release_held_new_jobs,
               IPP_DEACTIVATE_PRINTER=deactivate_printer,
               IPP_ACTIVATE_PRINTER=activate_printer,
               IPP_RESTART_PRINTER=restart_printer,
               IPP_SHUTDOWN_PRINTER=shutdown_printer,
               IPP_STARTUP_PRINTER=startup_printer,
               IPP_REPROCESS_JOB=reprocess_job,
               IPP_CANCEL_CURRENT_JOB=cancel_current_job,
               IPP_SUSPEND_CURRENT_JOB=suspend_current_job,
               IPP_RESUME_JOB=resume_job,
               IPP_PROMOTE_JOB=promote_job,
               IPP_SCHEDULE_JOB_AFTER=schedule_job_after,
               IPP_PRIVATE=private,
               CUPS_GET_DEFAULT=get_default,
               CUPS_GET_PRINTERS=get_printers,
               CUPS_ADD_MODIFY_PRINTER=add_modify_printer,
               CUPS_DELETE_PRINTER=delete_printer,
               CUPS_GET_CLASSES=get_classes,
               CUPS_ADD_MODIFY_CLASS=add_modify_class,
               CUPS_DELETE_CLASS=delete_class,
               CUPS_ACCEPT_JOBS=accept_jobs,
               CUPS_REJECT_JOBS=reject_jobs,
               CUPS_SET_DEFAULT=set_default,
               CUPS_GET_DEVICES=get_devices,
               CUPS_GET_PPDS=get_ppds,
               CUPS_MOVE_JOB=move_job,
               CUPS_AUTHENTICATE_JOB=authenticate_job,
               CUPS_GET_PPD=get_ppd)

# Process a get request which is usually for a PPD

def process_get(f, l):
    """Process a http get request"""

    # First read up to end of request

    while 1:
        line = f.readline()
        if line is None:
            break
        line = line.rstrip()
        if len(line) == 0:
            break

    # Try to parse the starting line

    m = re.match("GET\s+/printers/(.+)\s+HTTP", l)
    if not m:
        syslog.syslog(syslog.LOG_ERR, "Get request no match in %s" % l)
        return

    # Try to open the file

    pf = None
    for ptr in (m.group(1), Config_data.default_printer() + ".ppd", "Default.ppd"):
        try:
            fn = os.path.join(Config_data.ppddir, ptr)
            pf = open(fn, "rb")
            if Config_data.loglevel > 2:
                syslog.syslog(syslog.LOG_INFO, "Opened .ppd file %s" % fn)
            break
        except:
            pass

    if pf:
        st = os.fstat(pf.fileno())
        tim = time.ctime(st[stat.ST_MTIME])
        fsize = st[stat.ST_SIZE]
    else:
        tim = time.time()
        fsize = 0
        syslog.syslog(syslog.LOG_ERR, "Get request file not found for %s" % m.group(1))

    f.write("HTTP/1.1 200 OK\n")
    f.write("Date: %s\n" % time.ctime())
    f.write("Server: CUPS/1.2\n")
    f.write("Connection: Keep-Alive\n")
    f.write("Keep-Alive: timeout=60\n")
    f.write("Content-Language: en_US\n")
    f.write("Content-Type: application/vnd.cups-ppd\n")
    f.write("Last-Modified: %s\n" % tim)
    f.write("Content-Length: %d\n\n" % fsize)

    if pf:
        while 1:
            buf = pf.read(1024)
            lb = len(buf)
            if lb == 0:
                break
            f.write(buf)
        pf.close()

def process_post(f):
    """Process an HTTP POST request"""

    ipplength=0
    exp = False
    chnk = False

    # Read rest of header

    while 1:
        line = f.readline()
        if line is None:
            return

        l = line.rstrip()
        if  len(l) == 0:
            break

        m = re.search('Content-Length:\s*(\d+)', l, re.I)
        if m:
            ipplength=int(m.group(1))
            continue

        m = re.match('Expect:', l, re.I)
        if m:
            exp = True
            continue

        m = re.match('Transfer-Encoding:\s+chunked', l, re.I)
        if m:
            chnk = True

    # If we've had a request to request more, satisfy it

    if exp:
        f.write("HTTP/1.1 100 Continue\r\n\r\n")

    if chnk:
        f.set_chunked()
    else:
        if ipplength == 0:
            syslog.syslog(syslog.LOG_ERR, "No POST data")
            return
        f.set_expected(ipplength)

    # Parse IPP request

    ipr = ipp.ipp(f)
    try:
        ipr.parse()
        if Config_data.loglevel > 3:
            ipr.display()
    except ipp.IppError as mm:
        return

    iprcode = ipr.statuscode

    try:
        iprname = ipp.op_to_name[iprcode]
        syslog.syslog(syslog.LOG_INFO, "Request operation %s" % iprname)
        func = functab[iprname]
    except KeyError:
        return

    # Actually do the business and return an IPP string (filebuf is a structure member)

    resp = func(ipr)
    
    if  Config_data.loglevel > 2:
        ipresp = ipp.ipp(filebuf.stringbuf(resp, 0))
        ipresp.parse()
        syslog.syslog(syslog.LOG_INFO, "Reply sent %s" % ipp.resp_to_name[ipresp.statuscode])

    # Now decorate the response

    f.write("HTTP/1.1 200 OK\r\n")
    f.write("Date: %s\n" % time.ctime())
    f.write("Server: CUPS/1.2\r\n")
    f.write("Connection: Keep-Alive\r\n")
    f.write("Keep-Alive: timeout=60\r\n")
    f.write("Content-Language: en_US\r\n")
    f.write("Content-Type: application/ipp\r\n")
    f.write("Content-Length: %d\r\n\r\n" % len(resp))
    f.write(resp)

def parsefd(fd):
    """Parse incoming requests with HTTP header"""

    while 1:

        # Get first line which should be an HTTP request

        try:
            line = fd.readline()
            if line is None:
                return
            l = line.strip()
            if len(l) == 0:
                return

            m = re.match("(GET|PUT|POST|DELETE|TRACE|OPTIONS|HEAD)\s", l)
            if m:
                op = m.group(1)
                if op == "GET":
                    process_get(fd, l)
                elif op == "POST":
                    process_post(fd)
                else:
                    syslog.syslog(syslog.LOG_ERR, "Dont know how to handle %s http ops" % op)
                    return
            else:
                syslog.syslog(syslog.LOG_ERR, "No match for HTTP op")
                return
        except (socket.error, filebuf.filebufEOF):
            syslog.syslog(syslog.LOG_DEBUG, "Had EOF on socket")
            return

# Do the business in a thread

def cups_proc(conn, addr):
    """Process a connection and handle request"""
    fd = filebuf.httpfilebuf(conn, Config_data.timeouts)
    parsefd(fd)
    conn.close()

# Meat of the thing

def cups_server():
    """Accept connections on socket from people wanting to print stuff"""
    s = None
    port = socket.getservbyname('ipp', 'tcp')

    # Try to support ipv6 and ipv4

    socklist = []
    poss_socks = socket.getaddrinfo(None, port, socket.AF_UNSPEC, socket.SOCK_STREAM, 0, socket.AI_PASSIVE)
    act_socks = []

    # First find AF_INET6 if it's there
    # Unlike the advertising it might be anywhere
    # Then find AF_INET

    for afam in (socket.AF_INET6, socket.AF_INET):
        for p in poss_socks:
            af, socktype, proto, canonname, sa = p
            if af == afam:
                act_socks.append(p)
                break

    for p in  act_socks:
        af, socktype, proto, canonname, sa = p
        try:
            s = socket.socket(af, socktype, proto)
        except socket.error, msg:
            continue

        try:
            s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
            s.bind(sa)
            s.listen(5)

        except socket.error as msg:
            if msg.args[0] == errno.EACCES:
                sys.exit("Cannot access socket - no permission")

            # We may get EADDRINUSE from IPV4 if we've just set up IPV6 which we ignore
            if msg.args[0] == errno.EADDRINUSE and len(socklist) == 0 and af != socket.AF_INET:
                sys.exit("Socket in use - is CUPS running?")

            s.close()
            continue

        socklist.append(s)

    # If no success, abort
    if len(socklist) == 0:
        sys.exit("Sorry cannot start - unable to allocate socket?")

    while 1:
        rlist,wlist,xlist = select.select(socklist,(),())
        for s in rlist:
            connaddr = s.accept()
            th = threading.Thread(target=cups_proc, args=connaddr)
            th.daemon = True
            th.start()

def setup_pid():
    """Setup pid entry in /var/run/cups/cupsd.pid

Kill anything that's there already"""
    file = Var_run + "/" + Procid_file
    try:
        st = os.stat(file)
        if not stat.S_ISREG(st[stat.ST_MODE]):
            sys.exit("Unknown type file " + file)
        f = open(file, "rb")
        pidstr = f.read(100)
        f.close()
        pid = int(pidstr)
        os.kill(pid, signal.SIGTERM)
        time.sleep(5)
        try:
            os.kill(pid, signal.SIGKILL)
        except OSError:
            pass
        os.remove(file)
    except (OSError, IOError, ValueError):
        pass

    # Create directory if needed
    try:
        os.mkdir(Var_run, 0755)
    except OSError as err:
        if err.args[0] != errno.EEXIST:
            sys.exit("Cannot create " + Var_run + " " + err.args[1])
    try:
        f = open(file, "wb")
        f.write(str(os.getpid()) + "\n")
        f.close()
    except IOError as err:
        sys.exit("Cannot create " + file + " - " + err.args[1])

def remove_pid(signum, frame):
    """Remove pid entry in /var/run/cups/cupsd.pid"""
    try:
        os.remove(Var_run + '/' + Procid_file)
    except OSError:
        # Ignore errors
        pass
    sys.exit("CUPSPY terminated by signal")

# Run the stuff

if __name__ == "__main__":
    signal.signal(signal.SIGINT, signal.SIG_IGN)
    signal.signal(signal.SIGQUIT, signal.SIG_IGN)
    signal.signal(signal.SIGHUP, signal.SIG_IGN)
    if os.fork() != 0:
        os._exit(0)
    syslog.openlog('cupspy', syslog.LOG_NDELAY|syslog.LOG_PID, syslog.LOG_LPR)
    syslog.setlogmask(syslog.LOG_UPTO(Config_data.loglevel + syslog.LOG_ERR))
    syslog.syslog(syslog.LOG_INFO, "Starting")
    setup_pid()
    signal.signal(signal.SIGTERM, remove_pid)
    cups_server()