File: bjnp.c

package info (click to toggle)
cups-bjnp 2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 628 kB
  • ctags: 329
  • sloc: ansic: 2,519; sh: 1,254; makefile: 27
file content (436 lines) | stat: -rw-r--r-- 12,932 bytes parent folder | download
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
/*
 * bjnp backend for the Common UNIX Printing System (CUPS).
 * Copyright 2008-2014 by Louis Lagendijk
 *
 * Based on cups AppSocket sources
 * Copyright 2007 by Apple Inc.
 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
 *
 * 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; version 2 only.
 *
 * 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/>.
 */

/*
 * Include necessary headers.
 */

#include <stdio.h>
#include <stdarg.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <signal.h>
#include <errno.h>

#ifdef WIN32
#  include <winsock.h>
#else
#  include <unistd.h>
#  include <fcntl.h>
#  include <sys/socket.h>
#  include <netinet/in.h>
#  include <arpa/inet.h>
#  include <netdb.h>
#endif /* WIN32 */
#include "bjnp.h"


/*
 * 'main()' - Send a file to the printer or server.
 *
 * Usage:
 *
 *    printer-uri job-id user title copies options [file]
 */

int                               /* O - Exit status */
main(int argc,                    /* I - Number of command-line arguments */
     /*     (6 or 7) */
     char *argv[])                /* I - Command-line arguments */
{
    char method[255];             /* Method in URI */
    char hostname[1024];          /* Hostname */
    char username[255];           /* Username info (not used) */
    char resource[1024];          /* Resource info */
    char *options;                /* Pointer to options in device URI*/
    char *name;                   /* Name of option in device URI*/
    char *value;                  /* Value of option in device URI*/
    char sep;                     /* Option separator */
    int print_fd;                 /* Print file */
    int copies;                   /* Number of copies to print */
    time_t start_time;            /* Time of first connect */
    int recoverable;              /* Recoverable error shown? */
    int contimeout;               /* Connection timeout */
    int port;                     /* Port number */
    char portname[255];           /* Port name */
    char family[BJNP_FAMILY_MAX]; /* address family */
    int i;                        /* loop variable */
    int bjnp_error;               /* printer error */
    http_addrlist_t *addrlist;    /* Address list */
    printer_t *printer;           /* Connected printer */
    char addrname[256];           /* Address name */
    ssize_t tbytes;               /* Total number of bytes written */
    char *debug_level = NULL;     /* debug level to be applied */
    char *debug_file_name = NULL; /* filename for own debugging */
#if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
    struct sigaction action;      /* Actions for POSIX signals */
#endif /* HAVE_SIGACTION && !HAVE_SIGSET */


    /*
     * Make sure status messages are not buffered...
     */

    setbuf(stderr, NULL);

    /*
     * Ignore SIGPIPE signals...
     */

#ifdef HAVE_SIGSET
    sigset(SIGPIPE, SIG_IGN);
#elif defined(HAVE_SIGACTION)
    memset(&action, 0, sizeof(action));
    action.sa_handler = SIG_IGN;
    sigaction(SIGPIPE, &action, NULL);
#else
    signal(SIGPIPE, SIG_IGN);
#endif /* HAVE_SIGSET */

    /*
     * Check command-line...
     */

    if (argc == 1) {
        struct printer_list printers[BJNP_PRINTERS_MAX];
        int num_printers;
        int i;

        /*
         * get debug level for printer discovery based on environment settings
         */

        debug_level = getenv("BJNP_DEBUG_LEVEL");
        debug_file_name = getenv("BJNP_DEBUG_FILE");

        bjnp_set_debug_level(debug_level, debug_file_name);

        if ((num_printers = bjnp_discover_printers(printers)) == 0) {
            puts("network bjnp \"Unknown\" \"Canon network printer\"");
        } else {
            for (i = 0; i < num_printers; i++) {
                printf("network bjnp://%s:%u \"%s\" \"%s %s\" \"%s\"\n",
                       printers[i].hostname,
                       printers[i].port,
                       printers[i].model,
                       printers[i].model,
                       printers[i].hostname,
                       printers[i].IEEE1284_id);
            }
        }

        return (CUPS_BACKEND_OK);
    } else if (argc < 6 || argc > 7) {
        fprintf(stderr, "cups BJNP backend - version %s\n", VERSION);
        _cupsLangPrintf(stderr,
                        _("Usage: %s job-id user title copies options [file]\n"),
                        argv[0]);
        return CUPS_BACKEND_FAILED;
    }

    /*
     * If we have 7 arguments, print the file named on the command-line.
     * Otherwise, send stdin instead...
     */

    if (argc == 6) {
        print_fd = 0;
        copies = 1;
    } else {
        /*
         * Try to open the print file...
         */

        if ((print_fd = open(argv[6], O_RDONLY)) < 0) {
            perror("ERROR: unable to open print file");
            return CUPS_BACKEND_FAILED;
        }

        copies = atoi(argv[4]);
    }

    /*
     * Extract the hostname and port number from the URI...
     */

    httpSeparateURI(HTTP_URI_CODING_ALL, cupsBackendDeviceURI(argv),
                    method, sizeof(method), username, sizeof(username),
                    hostname, sizeof(hostname), &port,
                    resource, sizeof(resource));

    if (port == 0) {
        port =  BJNP_PORT_PRINT;
    }

    /*
     * Get options from the URI, if any...
     */

    contimeout = 7 * 24 * 60 * 60;

    if ((options = strchr(resource, '?')) != NULL) {
        /*
         * Yup, terminate the device name string and move to the first
         * character of the options...
         */

        *options++ = '\0';

        /*
         * Parse options...
         */

        while (*options) {
            /*
             * Get the name...
             */

            name = options;

            while (*options && *options != '=' && *options != '+'
                   && *options != '&') {
                options++;
            }

            if ((sep = *options) != '\0') {
                *options++ = '\0';
            }

            if (sep == '=') {
                /*
                 * Get the value...
                 */

                value = options;

                while (*options && *options != '+' && *options != '&') {
                    options++;
                }

                if (*options) {
                    *options++ = '\0';
                }
            } else {
                value = (char *) "";
            }

            /*
             * Process the option...
             */

            if (!strcasecmp(name, "contimeout")) {
                /*
                 * Set the connection timeout...
                 */

                if (atoi(value) > 0) {
                    contimeout = atoi(value);
                }
            } else if (!strcasecmp(name, "debuglevel")) {
                debug_level = value;
            } else if (!strcasecmp(name, "debugfile")) {
                debug_file_name = value;
            }
        }
    }

    bjnp_set_debug_level(debug_level, debug_file_name);

    /*
     * print command line arguments to debug log
     * We cannot do that sooner, as we first need to initialize
     * the debug system
     */

    for (i = 0; i < argc; i++) {
        bjnp_debug(LOG_DEBUG, "cups-bjnp: argv[%d] = %s\n", i, argv[i]);
    }

    /*
     * Then try to connect to the remote host...
     */

    recoverable = 0;
    start_time = time(NULL);

    sprintf(portname, "%d", port);

    if ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL) {
        _cupsLangPrintf(stderr, _("ERROR: Unable to locate printer \'%s\'!\n"),
                        hostname);
        return (CUPS_BACKEND_STOP);
    }

    _cupsLangPrintf(stderr,
                    _("INFO: Attempting to connect to host %s on port %d\n"),
                    hostname, port);

    fputs("STATE: +connecting-to-device\n", stderr);

    printer = NULL;

    while (1) {
        if (((printer = bjnp_printer_connect(printer, addrlist, argv[2], argv[3], &bjnp_error)) == NULL) ||
            bjnp_error != 0)  {

            if (getenv("CLASS") != NULL) {
                /*
                 * If the CLASS environment variable is set, the job was submitted
                 * to a class and not to a specific queue.  In this case, we want
                 * to abort immediately so that the job can be requeued on the next
                 * available printer in the class.
                 */

                _cupsLangPuts(stderr,
                              _
                              ("INFO: Unable to contact printer, queuing on next "
                               "printer in class...\n"));

                /*
                 * Sleep 5 seconds to keep the job from requeuing too rapidly...
                 */

                sleep(5);

                return CUPS_BACKEND_FAILED;
            }

            if (contimeout && (time(NULL) - start_time) > contimeout) {
                _cupsLangPuts(stderr,
                              _("ERROR: Printer not ready to print!\n"));
                return CUPS_BACKEND_FAILED;
            }

            recoverable = 1;

            if (bjnp_error != 0)  {
                if (bjnp_error & BJNP_PRINTER_BUSY) {
                    _cupsLangPrintf(stderr,
                                    _("WARNING: recoverable: Network printer \'%s\' is busy, "),
                                    hostname);
                }

                if (bjnp_error & BJNP_NO_INK) {
                    _cupsLangPrintf(stderr,
                                    _("WARNING: recoverable: Network printer \'%s\' is out of ink, "),
                                    hostname);
                }

                if (bjnp_error & BJNP_NO_PAPER) {
                    _cupsLangPrintf(stderr,
                                    _("WARNING: recoverable: Network host \'%s\' is out of paper, "),
                                    hostname);
                }

                _cupsLangPrintf(stderr,
                                _("will retry in 30 seconds...\n"));
                sleep(30);

            } else {
                _cupsLangPrintf(stderr, "DEBUG: Connection error: %s\n",
                                strerror(errno));
                _cupsLangPuts(stderr,
                              _
                              ("ERROR: recoverable: Unable to connect to printer; "
                               "will retry in 30 seconds...\n"));

                sleep(30);
            }
        } else {
            break;
        }
    }

    if (recoverable) {
        /*
         * If we've shown a recoverable error make sure the printer proxies
         * have a chance to see the recovered message. Not pretty but
         * necessary for now...
         */

        fputs("INFO: recovered: \n", stderr);
        sleep(5);
    }

    fputs("STATE: -connecting-to-device\n", stderr);
    _cupsLangPrintf(stderr, _("INFO: Connected to %s...\n"), hostname);

    get_printer_address_info(printer, addrname, &port, family);
    fprintf(stderr, "DEBUG: Connected to [%s]:%d (%s)...\n",
            addrname, port, family);

    /*
     * Print everything...
     */

    tbytes = 0;

    while (copies > 0 && tbytes >= 0) {
        copies--;

        if (print_fd != 0) {
            fputs("PAGE: 1 1\n", stderr);
            lseek(print_fd, 0, SEEK_SET);
        }

        tbytes = bjnp_backendRunLoop(print_fd, printer);

        if (print_fd != 0 && tbytes >= 0) {
#ifdef HAVE_LONG_LONG
            _cupsLangPrintf(stderr,
                            _("INFO: Sent print file, %lld bytes...\n"),
                            CUPS_LLCAST tbytes);
#else
            _cupsLangPrintf(stderr,
                            _("INFO: Sent print file, %ld bytes...\n"),
                            CUPS_LLCAST tbytes);
#endif /* HAVE_LONG_LONG */
        }
    }

    /*
     * tell printer to finsh the print job and to close the connection
     */
    bjnp_close_printer(printer);
    printer = NULL;
    httpAddrFreeList(addrlist);
    addrlist = NULL;

    /*
     * Close the input file and return...
     */

    if (print_fd != 0) {
        close(print_fd);
    }

    /*
     * delay a bit as otherwise next job may hang (reported by Zedonet for PIXMA MX7600)
     */

    sleep(15);

    if (tbytes >= 0) {
        _cupsLangPuts(stderr, _("INFO: Ready to print.\n"));
    }

    return (tbytes < 0 ? CUPS_BACKEND_FAILED : CUPS_BACKEND_OK);
}