s3: Use the status from cli_raw_ioctl in torture_ioctl_test
[samba.git] / source3 / printing / pcap.c
index 86489e9587c18f631d54e8e8bc88b9905ffbd775..a6bf52a0a4ced7559cfa66520f1543ceac82fd88 100644 (file)
@@ -13,7 +13,7 @@
    
    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 2 of the License, or
+   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,
    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., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 /*
- *  Parse printcap file.
- *
- *  This module does exactly one thing - it looks into the printcap file
- *  and tells callers if a specified string appears as a printer name.
+ *  This module contains code to parse and cache printcap data, possibly
+ *  in concert with the CUPS/SYSV/AIX-specific code found elsewhere.
  *
  *  The way this module looks at the printcap file is very simplistic.
  *  Only the local printcap file is inspected (no searching of NIS
  *
  *  Modified to call CUPS support if printcap name is set to "cups"
  *  in smb.conf.
+ *
+ *  Modified to call iPrint support if printcap name is set to "iprint"
+ *  in smb.conf.
  */
 
 #include "includes.h"
 
-#include "smb.h"
 
-#ifdef AIX
-/*  ******************************************
-     Extend for AIX system and qconfig file
-       from 'boulard@univ-rennes1.fr
-    ****************************************** */
-static int strlocate(char *xpLine,char *xpS)
+struct pcap_cache {
+       char *name;
+       char *comment;
+       struct pcap_cache *next;
+};
+
+/* The systemwide printcap cache. */
+static struct pcap_cache *pcap_cache = NULL;
+
+bool pcap_cache_add_specific(struct pcap_cache **ppcache, const char *name, const char *comment)
 {
-       int iS,iL,iRet;
-       char *p;
-       iS = strlen(xpS);
-       iL = strlen(xpLine);
-
-       iRet = 0;
-       p = xpLine;
-       while (iL >= iS)
-       {
-               if (strncmp(p,xpS,iS) == 0) {iRet =1;break;};
-               p++;
-               iL--;
-       }
-       /*DEBUG(3,(" strlocate %s in line '%s',ret=%d\n",xpS,xpLine,iRet));*/
-       
-       return(iRet);
+       struct pcap_cache *p;
+
+       if (name == NULL || ((p = SMB_MALLOC_P(struct pcap_cache)) == NULL))
+               return false;
+
+       p->name = SMB_STRDUP(name);
+       p->comment = (comment && *comment) ? SMB_STRDUP(comment) : NULL;
+
+       DEBUG(11,("pcap_cache_add_specific: Adding name %s info %s\n",
+               p->name, p->comment ? p->comment : ""));
+
+       p->next = *ppcache;
+       *ppcache = p;
+
+       return true;
 }
-       
-       
-/* ******************************************************************* */
-/* *    Scan qconfig and search all virtual printer (device printer) * */
-/* ******************************************************************* */
-static void ScanQconfig_fn(char *psz,void (*fn)(char *, char *))
+
+void pcap_cache_destroy_specific(struct pcap_cache **pp_cache)
 {
-       int iEtat;
-       XFILE *pfile;
-       char *line,*p;
-       pstring name,comment;
-       line  = NULL;
-       *name = 0;
-       *comment = 0;
-
-       if ((pfile = x_fopen(psz, O_RDONLY, 0)) == NULL)
-       {
-             DEBUG(0,( "Unable to open qconfig file %s for read!\n", psz));
-             return;
-       }
+       struct pcap_cache *p, *next;
 
-       iEtat = 0;
-       /* scan qconfig file for searching <printername>:       */
-       for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); safe_free(line))
-       {
-               if (*line == '*' || *line == 0)
-               continue;
-               switch (iEtat)
-               {
-                       case 0: /* locate an entry */
-                        if (*line == '\t' || *line == ' ') continue;
-                        if ((p=strchr_m(line,':')))
-                        {
-                               *p = '\0';
-                               p = strtok(line,":");
-                               if (strcmp(p,"bsh")!=0)
-                                 {
-                                   pstrcpy(name,p);
-                                   iEtat = 1;
-                                   continue;
-                                 }
-                        }
-                        break;
-                       case 1: /* scanning device stanza */
-                        if (*line == '*' || *line == 0) continue;
-                        if (*line != '\t' && *line != ' ')
-                        {
-                          /* name is found without stanza device  */
-                          /* probably a good printer ???               */
-                          fn(name,comment);
-                          iEtat = 0;
-                          continue;
-                         }
-                       
-                         if (strlocate(line,"backend"))
-                         {
-                               /* it's a device, not a virtual printer*/
-                               iEtat = 0;
-                         }
-                         else if (strlocate(line,"device"))
-                         {
-                               /* it's a good virtual printer */
-                               fn(name,comment);
-                               iEtat = 0;
-                               continue;
-                         }
-                         break;
-               }
+       for (p = *pp_cache; p != NULL; p = next) {
+               next = p->next;
+
+               SAFE_FREE(p->name);
+               SAFE_FREE(p->comment);
+               SAFE_FREE(p);
        }
-       x_fclose(pfile);
+       *pp_cache = NULL;
 }
 
-/* Scan qconfig file and locate de printername */
+bool pcap_cache_add(const char *name, const char *comment)
+{
+       return pcap_cache_add_specific(&pcap_cache, name, comment);
+}
 
-static BOOL ScanQconfig(char *psz,char *pszPrintername)
+bool pcap_cache_loaded(void)
 {
-       int iLg,iEtat;
-       XFILE *pfile;
-       char *pName;
-       char *line;
-
-       pName = NULL;
-       line  = NULL;
-       if ((pszPrintername!= NULL) && ((iLg = strlen(pszPrintername)) > 0))
-        pName = malloc(iLg+10);
-       if (pName == NULL)
-       {
-               DEBUG(0,(" Unable to allocate memory for printer %s\n",pszPrintername));
-               return(False);
-       }
-       if ((pfile = x_fopen(psz, O_RDONLY, 0)) == NULL)
-       {
-             DEBUG(0,( "Unable to open qconfig file %s for read!\n", psz));
-             SAFE_FREE(pName);
-             return(False);
-       }
-       slprintf(pName, iLg + 9, "%s:",pszPrintername);
-       iLg = strlen(pName);
-       /*DEBUG(3,( " Looking for entry %s\n",pName));*/
-       iEtat = 0;
-       /* scan qconfig file for searching <printername>:       */
-       for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); safe_free(line))
-       {
-               if (*line == '*' || *line == 0)
-               continue;
-               switch (iEtat)
-               {
-                       case 0: /* scanning entry */
-                        if (strncmp(line,pName,iLg) == 0)
-                        {
-                               iEtat = 1;
-                               continue;
-                        }
-                        break;
-                       case 1: /* scanning device stanza */
-                        if (*line == '*' || *line == 0) continue;
-                        if (*line != '\t' && *line != ' ')
-                        {
-                          /* name is found without stanza device  */
-                          /* probably a good printer ???               */
-                          free (line);
-                          SAFE_FREE(pName);
-                          fclose(pfile);
-                          return(True);
-                         }
-                       
-                         if (strlocate(line,"backend"))
-                         {
-                               /* it's a device, not a virtual printer*/
-                               iEtat = 0;
-                         }
-                         else if (strlocate(line,"device"))
-                         {
-                               /* it's a good virtual printer */
-                               free (line);
-                               SAFE_FREE(pName);
-                               fclose(pfile);
-                               return(True);
-                         }
-                         break;
-               }
-       }
-       free (pName);
-       x_fclose(pfile);
-       return(False);
+       return (pcap_cache != NULL);
 }
-#endif /* AIX */
 
+void pcap_cache_replace(const struct pcap_cache *pcache)
+{
+       const struct pcap_cache *p;
 
-/***************************************************************************
-Scan printcap file pszPrintcapname for a printer called pszPrintername. 
-Return True if found, else False. Returns False on error, too, after logging 
-the error at level 0. For generality, the printcap name may be passed - if
-passed as NULL, the configuration will be queried for the name. 
-***************************************************************************/
-BOOL pcap_printername_ok(const char *pszPrintername, const char *pszPrintcapname)
+       pcap_cache_destroy_specific(&pcap_cache);
+       for (p = pcache; p; p = p->next) {
+               pcap_cache_add(p->name, p->comment);
+       }
+}
+
+void pcap_cache_reload(void)
 {
-  char *line=NULL;
-  const char *psz;
-  char *p,*q;
-  XFILE *pfile;
-
-  if (pszPrintername == NULL || pszPrintername[0] == '\0')
-    {
-      DEBUG(0,( "Attempt to locate null printername! Internal error?\n"));
-      return(False);
-    }
-
-  /* only go looking if no printcap name supplied */
-  if ((psz = pszPrintcapname) == NULL || psz[0] == '\0')
-    if (((psz = lp_printcapname()) == NULL) || (psz[0] == '\0'))
-      {
-       DEBUG(0,( "No printcap file name configured!\n"));
-       return(False);
-      }
+       const char *pcap_name = lp_printcapname();
+       bool pcap_reloaded = False;
+       struct pcap_cache *tmp_cache = NULL;
+       XFILE *pcap_file;
+       char *pcap_line;
+
+       DEBUG(3, ("reloading printcap cache\n"));
+
+       /* only go looking if no printcap name supplied */
+       if (pcap_name == NULL || *pcap_name == 0) {
+               DEBUG(0, ("No printcap file name configured!\n"));
+               return;
+       }
+
+       tmp_cache = pcap_cache;
+       pcap_cache = NULL;
 
 #ifdef HAVE_CUPS
-    if (strequal(psz, "cups"))
-       return (cups_printername_ok(pszPrintername));
-#endif /* HAVE_CUPS */
+       if (strequal(pcap_name, "cups")) {
+               pcap_reloaded = cups_cache_reload();
+               goto done;
+       }
+#endif
+
+#ifdef HAVE_IPRINT
+       if (strequal(pcap_name, "iprint")) {
+               pcap_reloaded = iprint_cache_reload();
+               goto done;
+       }
+#endif
 
-#ifdef SYSV
-    if (strequal(psz, "lpstat"))
-       return (sysv_printername_ok(pszPrintername));
+#if defined(SYSV) || defined(HPUX)
+       if (strequal(pcap_name, "lpstat")) {
+               pcap_reloaded = sysv_cache_reload();
+               goto done;
+       }
 #endif
 
 #ifdef AIX
-  if (strlocate(psz,"/qconfig"))
-     return(ScanQconfig(psz,pszPrintername));
+       if (strstr_m(pcap_name, "/qconfig") != NULL) {
+               pcap_reloaded = aix_cache_reload();
+               goto done;
+       }
 #endif
 
-  if ((pfile = x_fopen(psz, O_RDONLY, 0)) == NULL)
-    {
-      DEBUG(0,( "Unable to open printcap file %s for read!\n", psz));
-      return(False);
-    }
+       /* handle standard printcap - moved from pcap_printer_fn() */
+
+       if ((pcap_file = x_fopen(pcap_name, O_RDONLY, 0)) == NULL) {
+               DEBUG(0, ("Unable to open printcap file %s for read!\n", pcap_name));
+               goto done;
+       }
+
+       for (; (pcap_line = fgets_slash(NULL, 1024, pcap_file)) != NULL; free(pcap_line)) {
+               char name[MAXPRINTERLEN+1];
+               char comment[62];
+               char *p, *q;
 
-  for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); safe_free(line))
-    {
-      if (*line == '#' || *line == 0)
-       continue;
+               if (*pcap_line == '#' || *pcap_line == 0)
+                       continue;
 
-      /* now we have a real printer line - cut it off at the first : */      
-      p = strchr_m(line,':');
-      if (p) *p = 0;
+               /* now we have a real printer line - cut at the first : */      
+               if ((p = strchr_m(pcap_line, ':')) != NULL)
+                       *p = 0;
       
-      /* now just check if the name is in the list */
-      /* NOTE: I avoid strtok as the fn calling this one may be using it */
-      for (p=line; p; p=q)
-       {
-         if ((q = strchr_m(p,'|'))) *q++ = 0;
-
-         if (strequal(p,pszPrintername))
-           {
-             SAFE_FREE(line);
-             x_fclose(pfile);
-             return(True);           
-           }
-         p = q;
+               /*
+                * now find the most likely printer name and comment 
+                * this is pure guesswork, but it's better than nothing
+                */
+               for (*name = *comment = 0, p = pcap_line; p != NULL; p = q) {
+                       bool has_punctuation;
+
+                       if ((q = strchr_m(p, '|')) != NULL)
+                               *q++ = 0;
+
+                       has_punctuation = (strchr_m(p, ' ') ||
+                                          strchr_m(p, '\t') ||
+                                          strchr_m(p, '(') ||
+                                          strchr_m(p, ')'));
+
+                       if (strlen(p) > strlen(comment) && has_punctuation) {
+                               strlcpy(comment, p, sizeof(comment));
+                               continue;
+                       }
+
+                       if (strlen(p) <= MAXPRINTERLEN &&
+                           strlen(p) > strlen(name) && !has_punctuation) {
+                               if (!*comment) {
+                                       strlcpy(comment, name, sizeof(comment));
+                               }
+                               strlcpy(name, p, sizeof(name));
+                               continue;
+                       }
+
+                       if (!strchr_m(comment, ' ') &&
+                           strlen(p) > strlen(comment)) {
+                               strlcpy(comment, p, sizeof(comment));
+                               continue;
+                       }
+               }
+
+               comment[60] = 0;
+               name[MAXPRINTERLEN] = 0;
+
+               if (*name && !pcap_cache_add(name, comment)) {
+                       x_fclose(pcap_file);
+                       goto done;
+               }
        }
-    }
 
-  x_fclose(pfile);
-  return(False);
+       x_fclose(pcap_file);
+       pcap_reloaded = True;
+
+done:
+       DEBUG(3, ("reload status: %s\n", (pcap_reloaded) ? "ok" : "error"));
+
+       if (pcap_reloaded)
+               pcap_cache_destroy_specific(&tmp_cache);
+       else {
+               pcap_cache_destroy_specific(&pcap_cache);
+               pcap_cache = tmp_cache;
+       }
+
+       return;
 }
 
 
-/***************************************************************************
-run a function on each printer name in the printcap file. The function is 
-passed the primary name and the comment (if possible). Note the fn() takes
-strings in DOS codepage. This means the xxx_printer_fn() calls must be fixed
-to return DOS codepage. FIXME !! JRA.
-***************************************************************************/
-void pcap_printer_fn(void (*fn)(char *, char *))
+bool pcap_printername_ok(const char *printername)
 {
-  pstring name,comment;
-  char *line;
-  char *psz;
-  char *p,*q;
-  XFILE *pfile;
-
-  /* only go looking if no printcap name supplied */
-  if (((psz = lp_printcapname()) == NULL) || (psz[0] == '\0'))
-    {
-      DEBUG(0,( "No printcap file name configured!\n"));
-      return;
-    }
+       struct pcap_cache *p;
 
-#ifdef HAVE_CUPS
-    if (strequal(psz, "cups")) {
-      cups_printer_fn(fn);
-      return;
-    }
-#endif /* HAVE_CUPS */
-
-#ifdef SYSV
-    if (strequal(psz, "lpstat")) {
-      sysv_printer_fn(fn);
-      return;
-    }
-#endif
+       for (p = pcap_cache; p != NULL; p = p->next)
+               if (strequal(p->name, printername))
+                       return True;
 
-#ifdef AIX
-  if (strlocate(psz,"/qconfig"))
-  {
-       ScanQconfig_fn(psz,fn);
-     return;
-  }
-#endif
+       return False;
+}
 
-  if ((pfile = x_fopen(psz, O_RDONLY, 0)) == NULL)
-    {
-      DEBUG(0,( "Unable to open printcap file %s for read!\n", psz));
-      return;
-    }
+/***************************************************************************
+run a function on each printer name in the printcap file.
+***************************************************************************/
 
-  for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); safe_free(line))
-    {
-      if (*line == '#' || *line == 0)
-       continue;
+void pcap_printer_fn_specific(const struct pcap_cache *pc,
+                       void (*fn)(const char *, const char *, void *),
+                       void *pdata)
+{
+       const struct pcap_cache *p;
 
-      /* now we have a real printer line - cut it off at the first : */      
-      p = strchr_m(line,':');
-      if (p) *p = 0;
-      
-      /* now find the most likely printer name and comment 
-       this is pure guesswork, but it's better than nothing */
-      *name = 0;
-      *comment = 0;
-      for (p=line; p; p=q)
-       {
-         BOOL has_punctuation;
-         if ((q = strchr_m(p,'|'))) *q++ = 0;
-
-         has_punctuation = (strchr_m(p,' ') || strchr_m(p,'\t') || strchr_m(p,'(') || strchr_m(p,')'));
-
-         if (strlen(p)>strlen(comment) && has_punctuation)
-           {
-             StrnCpy(comment,p,sizeof(comment)-1);
-             continue;
-           }
-
-         if (strlen(p) <= MAXPRINTERLEN && strlen(p)>strlen(name) && !has_punctuation)
-           {
-             if (!*comment) pstrcpy(comment,name);
-             pstrcpy(name,p);
-             continue;
-           }
-
-         if (!strchr_m(comment,' ') && 
-             strlen(p) > strlen(comment))
-           {
-             StrnCpy(comment,p,sizeof(comment)-1);
-             continue;
-           }
-       }
+       for (p = pc; p != NULL; p = p->next)
+               fn(p->name, p->comment, pdata);
 
-      comment[60] = 0;
-      name[MAXPRINTERLEN] = 0;
+       return;
+}
 
-      if (*name) 
-       fn(name,comment);
-    }
-  x_fclose(pfile);
+void pcap_printer_fn(void (*fn)(const char *, const char *, void *), void *pdata)
+{
+       pcap_printer_fn_specific(pcap_cache, fn, pdata);
 }