s3/printing: make clock jump save and use monotonic time for cache timeout
[kamenim/samba.git] / source3 / printing / pcap.c
index 8973b1627fb02f8fcb0c41982b6315e65ff12214..1b8f46d8e719e73170dea443880c394100d9cf4b 100644 (file)
@@ -1,16 +1,19 @@
 /* 
-   Unix SMB/Netbios implementation.
-   Version 1.9.
+   Unix SMB/CIFS implementation.
    printcap parsing
-   Copyright (C) Karl Auer 1993,1994
+   Copyright (C) Karl Auer 1993-1998
 
    Re-working by Martin Kiff, 1994
    
    Re-written again by Andrew Tridgell
+
+   Modified for SVID support by Norm Jacobs, 1997
+
+   Modified for CUPS support by Michael Sweet, 1999
    
    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.
- *
- *  The way this module looks at the printcap file is very simplistic.
- *  Only the local printcap file is inspected (no searching of NIS
- *  databases etc).
+ *  Modified to call SVID/XPG4 support if printcap name is set to "lpstat"
+ *  in smb.conf under Solaris.
  *
- *  There are assumed to be one or more printer names per record, held
- *  as a set of sub-fields separated by vertical bar symbols ('|') in the
- *  first field of the record. The field separator is assumed to be a colon
- *  ':' and the record separator a newline.
- * 
- *  Lines ending with a backspace '\' are assumed to flag that the following
- *  line is a continuation line so that a set of lines can be read as one
- *  printcap entry.
+ *  Modified to call CUPS support if printcap name is set to "cups"
+ *  in smb.conf.
  *
- *  A line stating with a hash '#' is assumed to be a comment and is ignored
- *  Comments are discarded before the record is strung together from the
- *  set of continuation lines.
- *
- *  Opening a pipe for "lpc status" and reading that would probably 
- *  be pretty effective. Code to do this already exists in the freely
- *  distributable PCNFS server code.
+ *  Modified to call iPrint support if printcap name is set to "iprint"
+ *  in smb.conf.
  */
 
 #include "includes.h"
+#include "printing/pcap.h"
+#include "printer_list.h"
+
+struct pcap_cache {
+       char *name;
+       char *comment;
+       struct pcap_cache *next;
+};
 
-#include "smb.h"
-#include "loadparm.h"
-#include "pcap.h"
+bool pcap_cache_add_specific(struct pcap_cache **ppcache, const char *name, const char *comment)
+{
+       struct pcap_cache *p;
 
-extern int DEBUGLEVEL;
+       if (name == NULL || ((p = SMB_MALLOC_P(struct pcap_cache)) == NULL))
+               return false;
 
-#ifdef AIX
-/*  ******************************************
-     Extend for AIX system and qconfig file
-       from 'boulard@univ-rennes1.fr
-    ****************************************** */
-static int strlocate(char *xpLine,char *xpS)
+       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;
+}
+
+void pcap_cache_destroy_specific(struct pcap_cache **pp_cache)
 {
-       int iS,iL,i,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--;
+       struct pcap_cache *p, *next;
+
+       for (p = *pp_cache; p != NULL; p = next) {
+               next = p->next;
+
+               SAFE_FREE(p->name);
+               SAFE_FREE(p->comment);
+               SAFE_FREE(p);
        }
-       /*DEBUG(3,(" strlocate %s in line '%s',ret=%d\n",xpS,xpLine,iRet));*/
-       
-       return(iRet);
+       *pp_cache = NULL;
 }
-       
-       
-/* ******************************************************************* */
-/* *    Scan qconfig and search all virtual printer (device printer) * */
-/* ******************************************************************* */
-static void ScanQconfig_fn(char *psz,void (*fn)())
+
+bool pcap_cache_add(const char *name, const char *comment)
 {
-       int iLg,iEtat;
-       FILE *pfile;
-       char *line,*p;
-       pstring name,comment;
-       line  = NULL;
-       *name = 0;
-       *comment = 0;
-
-       if ((pfile = fopen(psz, "r")) == NULL)
-       {
-             DEBUG(0,( "Unable to open qconfig file %s for read!\n", psz));
-             return;
-       }
+       NTSTATUS status;
+       time_t t = time_mono(NULL);
 
-       iEtat = 0;
-       /* scan qconfig file for searching <printername>:       */
-       for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); free(line))
-       {
-               if (*line == '*' || *line == 0)
-               continue;
-               switch (iEtat)
-               {
-                       case 0: /* locate an entry */
-                        if (*line == '\t' || *line == ' ') continue;
-                        if ((p=strchr(line,':')))
-                        {
-                               *p = '\0';
-                               p = strtok(line,":");
-                               if (strcmp(p,"bsh")!=0)
-                                 {
-                                   strcpy(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;
-               }
-       }
-       fclose(pfile);
+       status = printer_list_set_printer(talloc_tos(), name, comment, t);
+       return NT_STATUS_IS_OK(status);
 }
 
-/* Scan qconfig file and locate de printername */
+bool pcap_cache_loaded(void)
+{
+       NTSTATUS status;
+       time_t last;
+
+       status = printer_list_get_last_refresh(&last);
+       return NT_STATUS_IS_OK(status);
+}
 
-static BOOL ScanQconfig(char *psz,char *pszPrintername)
+void pcap_cache_replace(const struct pcap_cache *pcache)
 {
-       int iLg,iEtat;
-       FILE *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);
+       const struct pcap_cache *p;
+
+       for (p = pcache; p; p = p->next) {
+               pcap_cache_add(p->name, p->comment);
        }
-       if ((pfile = fopen(psz, "r")) == NULL)
-       {
-             DEBUG(0,( "Unable to open qconfig file %s for read!\n", psz));
-             free(pName);
-             return(False);
+}
+
+void pcap_cache_reload(struct tevent_context *ev,
+                      struct messaging_context *msg_ctx)
+{
+       const char *pcap_name = lp_printcapname();
+       bool pcap_reloaded = False;
+       NTSTATUS status;
+
+       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;
        }
-       sprintf(pName,"%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)); 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);
-                          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);
-                               free(pName);
-                               fclose(pfile);
-                               return(True);
-                         }
-                         break;
-               }
+
+       if (!printer_list_need_refresh()) {
+               /* has been just refeshed, skip */
+               DEBUG(5, ("Refresh just happend, skipping.\n"));
+               return;
        }
-       free (pName);
-       fclose(pfile);
-       return(False);
-}
 
+       status = printer_list_mark_reload();
+       if (!NT_STATUS_IS_OK(status)) {
+               DEBUG(0, ("Failed to mark printer list for reload!\n"));
+               return;
+       }
+
+#ifdef HAVE_CUPS
+       if (strequal(pcap_name, "cups")) {
+               pcap_reloaded = cups_cache_reload(ev, msg_ctx);
+               goto done;
+       }
 #endif
-/***************************************************************************
-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(char *pszPrintername, char *pszPrintcapname)
-{
-  char *line=NULL;
-  char *psz;
-  char *p,*q;
-  FILE *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);
-      }
-#ifdef AIX
-  if (strlocate(psz,"/qconfig") != NULL)
-     return(ScanQconfig(psz,pszPrintername));
+
+#ifdef HAVE_IPRINT
+       if (strequal(pcap_name, "iprint")) {
+               pcap_reloaded = iprint_cache_reload();
+               goto done;
+       }
+#endif
+
+#if defined(SYSV) || defined(HPUX)
+       if (strequal(pcap_name, "lpstat")) {
+               pcap_reloaded = sysv_cache_reload();
+               goto done;
+       }
 #endif
-  if ((pfile = fopen(psz, "r")) == NULL)
-    {
-      DEBUG(0,( "Unable to open printcap file %s for read!\n", psz));
-      return(False);
-    }
-
-  for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); free(line))
-    {
-      if (*line == '#' || *line == 0)
-       continue;
-
-      /* now we have a real printer line - cut it off at the first : */      
-      p = strchr(line,':');
-      if (p) *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(p,'|'))) *q++ = 0;
-
-         if (strequal(p,pszPrintername))
-           {
-             /* normalise the case */
-             strcpy(pszPrintername,p);
-             free(line);
-             fclose(pfile);
-             return(True);           
-           }
-         p = q;
+
+#ifdef AIX
+       if (strstr_m(pcap_name, "/qconfig") != NULL) {
+               pcap_reloaded = aix_cache_reload();
+               goto done;
        }
-    }
+#endif
+
+       pcap_reloaded = std_pcap_cache_reload(pcap_name);
 
+done:
+       DEBUG(3, ("reload status: %s\n", (pcap_reloaded) ? "ok" : "error"));
 
-  fclose(pfile);
-  return(False);
+       if (pcap_reloaded) {
+               /* cleanup old entries only if the operation was successful,
+                * otherwise keep around the old entries until we can
+                * successfuly reaload */
+               status = printer_list_clean_old();
+               if (!NT_STATUS_IS_OK(status)) {
+                       DEBUG(0, ("Failed to cleanup printer list!\n"));
+               }
+       }
+
+       return;
 }
 
 
+bool pcap_printername_ok(const char *printername)
+{
+       NTSTATUS status;
+
+       status = printer_list_get_printer(talloc_tos(), printername, NULL, 0);
+       return NT_STATUS_IS_OK(status);
+}
+
 /***************************************************************************
-run a function on each printer name in the printcap file. The function is 
-passed the primary name and the comment (if possible)
+run a function on each printer name in the printcap file.
 ***************************************************************************/
-void pcap_printer_fn(void (*fn)())
+
+void pcap_printer_fn_specific(const struct pcap_cache *pc,
+                       void (*fn)(const char *, const char *, void *),
+                       void *pdata)
 {
-  pstring name,comment;
-  char *line;
-  char *psz;
-  char *p,*q;
-  FILE *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;
-    }
+       const struct pcap_cache *p;
 
-#ifdef AIX
-  if (strlocate(psz,"/qconfig") != NULL)
-  {
-       ScanQconfig_fn(psz,fn);
-     return;
-  }
-#endif
-  if ((pfile = fopen(psz, "r")) == NULL)
-    {
-      DEBUG(0,( "Unable to open printcap file %s for read!\n", psz));
-      return;
-    }
-
-  for (;(line = fgets_slash(NULL,sizeof(pstring),pfile)); free(line))
-    {
-      if (*line == '#' || *line == 0)
-       continue;
-
-      /* now we have a real printer line - cut it off at the first : */      
-      p = strchr(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(p,'|'))) *q++ = 0;
-
-         has_punctuation = (strchr(p,' ') || strchr(p,'(') || strchr(p,')'));
-
-         if (strlen(p)>strlen(comment) && has_punctuation)
-           {
-             StrnCpy(comment,p,sizeof(comment)-1);
-             continue;
-           }
-
-         if (strlen(p) <= 8 && strlen(p)>strlen(name) && !has_punctuation)
-           {
-             if (!*comment) strcpy(comment,name);
-             strcpy(name,p);
-             continue;
-           }
-
-         if (!strchr(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[8] = 0;
+       return;
+}
 
-      if (*name)
-       fn(name,comment);
-    }
-  fclose(pfile);
+void pcap_printer_fn(void (*fn)(const char *, const char *, void *), void *pdata)
+{
+       NTSTATUS status;
+
+       status = printer_list_run_fn(fn, pdata);
+       if (!NT_STATUS_IS_OK(status)) {
+               DEBUG(3, ("Failed to run fn for all printers!\n"));
+       }
+       return;
 }