source/printing/pcap.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 1.9.
   4    printcap parsing
   5    Copyright (C) Karl Auer 1993-1998
   6
   7    Re-working by Martin Kiff, 1994
   8
   9    Re-written again by Andrew Tridgell
  10
  11    Modified for SVID support by Norm Jacobs, 1997
  12
  13    Modified for CUPS support by Michael Sweet, 1999
  14
  15    This program is free software; you can redistribute it and/or modify
  16    it under the terms of the GNU General Public License as published by
  17    the Free Software Foundation; either version 2 of the License, or
  18    (at your option) any later version.
  19
  20    This program is distributed in the hope that it will be useful,
  21    but WITHOUT ANY WARRANTY; without even the implied warranty of
  22    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23    GNU General Public License for more details.
  24
  25    You should have received a copy of the GNU General Public License
  26    along with this program; if not, write to the Free Software
  27    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  28 */
  29
  30 /*
  31  *  Parse printcap file.
  32  *
  33  *  This module does exactly one thing - it looks into the printcap file
  34  *  and tells callers if a specified string appears as a printer name.
  35  *
  36  *  The way this module looks at the printcap file is very simplistic.
  37  *  Only the local printcap file is inspected (no searching of NIS
  38  *  databases etc).
  39  *
  40  *  There are assumed to be one or more printer names per record, held
  41  *  as a set of sub-fields separated by vertical bar symbols ('|') in the
  42  *  first field of the record. The field separator is assumed to be a colon
  43  *  ':' and the record separator a newline.
  44  *
  45  *  Lines ending with a backspace '\' are assumed to flag that the following
  46  *  line is a continuation line so that a set of lines can be read as one
  47  *  printcap entry.
  48  *
  49  *  A line stating with a hash '#' is assumed to be a comment and is ignored
  50  *  Comments are discarded before the record is strung together from the
  51  *  set of continuation lines.
  52  *
  53  *  Opening a pipe for "lpc status" and reading that would probably
  54  *  be pretty effective. Code to do this already exists in the freely
  55  *  distributable PCNFS server code.
  56  *
  57  *  Modified to call SVID/XPG4 support if printcap name is set to "lpstat"
  58  *  in smb.conf under Solaris.
  59  *
  60  *  Modified to call CUPS support if printcap name is set to "cups"
  61  *  in smb.conf.
  62  */
  63
  64 #include "includes.h"
  65
  66 #include "smb.h"
  67
  68 #ifdef AIX
  69 /*  ******************************************
  70      Extend for AIX system and qconfig file
  71        from 'boulard@univ-rennes1.fr
  72     ****************************************** */
  73 static int strlocate(char *xpLine,char *xpS)
  74 {
  75         int iS,iL,iRet;
  76         char *p;
  77         iS = strlen(xpS);
  78         iL = strlen(xpLine);
  79
  80         iRet = 0;
  81         p = xpLine;
  82         while (iL >= iS)
  83         {
  84                 if (strncmp(p,xpS,iS) == 0) {iRet =1;break;};
  85                 p++;
  86                 iL--;
  87         }
  88         /*DEBUG(3,(" strlocate %s in line '%s',ret=%d\n",xpS,xpLine,iRet));*/
  89
  90         return(iRet);
  91 }
  92
  93
  94 /* ******************************************************************* */
  95 /* *    Scan qconfig and search all virtual printer (device printer) * */
  96 /* ******************************************************************* */
  97 static void ScanQconfig_fn(char *psz,void (*fn)(char *, char *))
  98 {
  99         int iEtat;
 100         FILE *pfile;
 101         char *line,*p;
 102         pstring name,comment;
 103         line  = NULL;
 104         *name = 0;
 105         *comment = 0;
 106
 107         if ((pfile = sys_fopen(psz, "r")) == NULL)
 108         {
 109               DEBUG(0,( "Unable to open qconfig file %s for read!\n", psz));
 110               return;
 111         }
 112
 113         iEtat = 0;
 114         /* scan qconfig file for searching <printername>:       */
 115         for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); safe_free(line))
 116         {
 117                 if (*line == '*' || *line == 0)
 118                 continue;
 119                 switch (iEtat)
 120                 {
 121                         case 0: /* locate an entry */
 122                          if (*line == '\t' || *line == ' ') continue;
 123                          if ((p=strchr(line,':')))
 124                          {
 125                                 *p = '\0';
 126                                 p = strtok(line,":");
 127                                 if (strcmp(p,"bsh")!=0)
 128                                   {
 129                                     pstrcpy(name,p);
 130                                     iEtat = 1;
 131                                     continue;
 132                                   }
 133                          }
 134                          break;
 135                         case 1: /* scanning device stanza */
 136                          if (*line == '*' || *line == 0) continue;
 137                          if (*line != '\t' && *line != ' ')
 138                          {
 139                            /* name is found without stanza device  */
 140                            /* probably a good printer ???               */
 141                            fn(name,comment);
 142                            iEtat = 0;
 143                            continue;
 144                           }
 145
 146                           if (strlocate(line,"backend"))
 147                           {
 148                                 /* it's a device, not a virtual printer*/
 149                                 iEtat = 0;
 150                           }
 151                           else if (strlocate(line,"device"))
 152                           {
 153                                 /* it's a good virtual printer */
 154                                 fn(name,comment);
 155                                 iEtat = 0;
 156                                 continue;
 157                           }
 158                           break;
 159                 }
 160         }
 161         fclose(pfile);
 162 }
 163
 164 /* Scan qconfig file and locate de printername */
 165
 166 static BOOL ScanQconfig(char *psz,char *pszPrintername)
 167 {
 168         int iLg,iEtat;
 169         FILE *pfile;
 170         char *pName;
 171         char *line;
 172
 173         pName = NULL;
 174         line  = NULL;
 175         if ((pszPrintername!= NULL) && ((iLg = strlen(pszPrintername)) > 0))
 176          pName = malloc(iLg+10);
 177         if (pName == NULL)
 178         {
 179                 DEBUG(0,(" Unable to allocate memory for printer %s\n",pszPrintername));
 180                 return(False);
 181         }
 182         if ((pfile = sys_fopen(psz, "r")) == NULL)
 183         {
 184               DEBUG(0,( "Unable to open qconfig file %s for read!\n", psz));
 185               SAFE_FREE(pName);
 186               return(False);
 187         }
 188         slprintf(pName, iLg + 9, "%s:",pszPrintername);
 189         iLg = strlen(pName);
 190         /*DEBUG(3,( " Looking for entry %s\n",pName));*/
 191         iEtat = 0;
 192         /* scan qconfig file for searching <printername>:       */
 193         for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); safe_free(line))
 194         {
 195                 if (*line == '*' || *line == 0)
 196                 continue;
 197                 switch (iEtat)
 198                 {
 199                         case 0: /* scanning entry */
 200                          if (strncmp(line,pName,iLg) == 0)
 201                          {
 202                                 iEtat = 1;
 203                                 continue;
 204                          }
 205                          break;
 206                         case 1: /* scanning device stanza */
 207                          if (*line == '*' || *line == 0) continue;
 208                          if (*line != '\t' && *line != ' ')
 209                          {
 210                            /* name is found without stanza device  */
 211                            /* probably a good printer ???               */
 212                            SAFE_FREE (line);
 213                            SAFE_FREE(pName);
 214                            fclose(pfile);
 215                            return(True);
 216                           }
 217
 218                           if (strlocate(line,"backend"))
 219                           {
 220                                 /* it's a device, not a virtual printer*/
 221                                 iEtat = 0;
 222                           }
 223                           else if (strlocate(line,"device"))
 224                           {
 225                                 /* it's a good virtual printer */
 226                                 SAFE_FREE (line);
 227                                 SAFE_FREE(pName);
 228                                 fclose(pfile);
 229                                 return(True);
 230                           }
 231                           break;
 232                 }
 233         }
 234         SAFE_FREE (pName);
 235         fclose(pfile);
 236         return(False);
 237 }
 238 #endif /* AIX */
 239
 240
 241 /***************************************************************************
 242 Scan printcap file pszPrintcapname for a printer called pszPrintername.
 243 Return True if found, else False. Returns False on error, too, after logging
 244 the error at level 0. For generality, the printcap name may be passed - if
 245 passed as NULL, the configuration will be queried for the name. pszPrintername
 246 must be in DOS codepage.
 247 The xxx_printername_ok functions need fixing to understand they are being
 248 given a DOS codepage. FIXME !! JRA.
 249 ***************************************************************************/
 250
 251 BOOL pcap_printername_ok(char *pszPrintername, const char *pszPrintcapname)
 252 {
 253   char *line=NULL;
 254   const char *psz;
 255   char *p,*q;
 256   FILE *pfile;
 257
 258   if (pszPrintername == NULL || pszPrintername[0] == '\0')
 259     {
 260       DEBUG(0,( "Attempt to locate null printername! Internal error?\n"));
 261       return(False);
 262     }
 263
 264   /* only go looking if no printcap name supplied */
 265   if ((psz = pszPrintcapname) == NULL || psz[0] == '\0')
 266     if (((psz = lp_printcapname()) == NULL) || (psz[0] == '\0'))
 267       {
 268         DEBUG(0,( "No printcap file name configured!\n"));
 269         return(False);
 270       }
 271
 272 #ifdef HAVE_CUPS
 273     if (strequal(psz, "cups"))
 274        return (cups_printername_ok(pszPrintername));
 275 #endif /* HAVE_CUPS */
 276
 277 #ifdef SYSV
 278     if (strequal(psz, "lpstat"))
 279        return (sysv_printername_ok(pszPrintername));
 280 #endif
 281
 282 #ifdef AIX
 283   if (strlocate(psz,"/qconfig"))
 284      return(ScanQconfig(psz,pszPrintername));
 285 #endif
 286
 287   if ((pfile = sys_fopen(psz, "r")) == NULL)
 288     {
 289       DEBUG(0,( "Unable to open printcap file %s for read!\n", psz));
 290       return(False);
 291     }
 292
 293   for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); safe_free(line))
 294     {
 295       if (*line == '#' || *line == 0)
 296         continue;
 297
 298       unix_to_dos(line);
 299
 300       /* now we have a real printer line - cut it off at the first : */
 301       p = strchr(line,':');
 302       if (p) *p = 0;
 303
 304       /* now just check if the name is in the list */
 305       /* NOTE: I avoid strtok as the fn calling this one may be using it */
 306       for (p=line; p; p=q)
 307         {
 308           if ((q = strchr(p,'|'))) *q++ = 0;
 309
 310           if (strequal(p,pszPrintername))
 311             {
 312               /* normalise the case */
 313               pstrcpy(pszPrintername,p);
 314               SAFE_FREE(line);
 315               fclose(pfile);
 316               return(True);
 317             }
 318           p = q;
 319         }
 320     }
 321
 322   fclose(pfile);
 323   return(False);
 324 }
 325
 326
 327 /***************************************************************************
 328 run a function on each printer name in the printcap file. The function is
 329 passed the primary name and the comment (if possible). Note the fn() takes
 330 strings in DOS codepage. This means the xxx_printer_fn() calls must be fixed
 331 to return DOS codepage. FIXME !! JRA.
 332 ***************************************************************************/
 333 void pcap_printer_fn(void (*fn)(char *, char *))
 334 {
 335   pstring name,comment;
 336   char *line;
 337   char *psz;
 338   char *p,*q;
 339   FILE *pfile;
 340
 341   /* only go looking if no printcap name supplied */
 342   if (((psz = lp_printcapname()) == NULL) || (psz[0] == '\0'))
 343     {
 344       DEBUG(0,( "No printcap file name configured!\n"));
 345       return;
 346     }
 347
 348 #ifdef HAVE_CUPS
 349     if (strequal(psz, "cups")) {
 350       cups_printer_fn(fn);
 351       return;
 352     }
 353 #endif /* HAVE_CUPS */
 354
 355 #ifdef SYSV
 356     if (strequal(psz, "lpstat")) {
 357       sysv_printer_fn(fn);
 358       return;
 359     }
 360 #endif
 361
 362 #ifdef AIX
 363   if (strlocate(psz,"/qconfig"))
 364   {
 365         ScanQconfig_fn(psz,fn);
 366      return;
 367   }
 368 #endif
 369
 370   if ((pfile = sys_fopen(psz, "r")) == NULL)
 371     {
 372       DEBUG(0,( "Unable to open printcap file %s for read!\n", psz));
 373       return;
 374     }
 375
 376   for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); safe_free(line))
 377     {
 378       if (*line == '#' || *line == 0)
 379         continue;
 380
 381       /* now we have a real printer line - cut it off at the first : */
 382       p = strchr(line,':');
 383       if (p) *p = 0;
 384
 385       unix_to_dos(line);
 386
 387       /* now find the most likely printer name and comment
 388        this is pure guesswork, but it's better than nothing */
 389       *name = 0;
 390       *comment = 0;
 391       for (p=line; p; p=q)
 392         {
 393           BOOL has_punctuation;
 394           if ((q = strchr(p,'|'))) *q++ = 0;
 395
 396           has_punctuation = (strchr(p,' ') || strchr(p,'\t') || strchr(p,'(') || strchr(p,')'));
 397
 398           if (strlen(p)>strlen(comment) && has_punctuation)
 399             {
 400               StrnCpy(comment,p,sizeof(comment)-1);
 401               continue;
 402             }
 403
 404           if (strlen(p) <= MAXPRINTERLEN && strlen(p)>strlen(name) && !has_punctuation)
 405             {
 406               if (!*comment) pstrcpy(comment,name);
 407               pstrcpy(name,p);
 408               continue;
 409             }
 410
 411           if (!strchr(comment,' ') &&
 412               strlen(p) > strlen(comment))
 413             {
 414               StrnCpy(comment,p,sizeof(comment)-1);
 415               continue;
 416             }
 417         }
 418
 419       comment[60] = 0;
 420       name[MAXPRINTERLEN] = 0;
 421
 422       if (*name)
 423         fn(name,comment);
 424     }
 425   fclose(pfile);
 426 }