s3/printing: make clock jump save and use monotonic time for cache timeout
[kamenim/samba.git] / source3 / printing / pcap.c
index 0495b6fc1fc2e71d10f4a42699b8b3d4a8744705..1b8f46d8e719e73170dea443880c394100d9cf4b 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/>.
 */
 
 /*
- *  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
- *  databases etc).
- *
- *  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.
- *
- *  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 SVID/XPG4 support if printcap name is set to "lpstat"
  *  in smb.conf under Solaris.
  *
  *  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 "printing/pcap.h"
+#include "printer_list.h"
 
-
-typedef struct pcap_cache {
+struct pcap_cache {
        char *name;
        char *comment;
        struct pcap_cache *next;
-} pcap_cache_t;
-
-static pcap_cache_t *pcap_cache = NULL;
+};
 
-BOOL pcap_cache_add(const char *name, const char *comment)
+bool pcap_cache_add_specific(struct pcap_cache **ppcache, const char *name, const char *comment)
 {
-       pcap_cache_t *p;
+       struct pcap_cache *p;
 
-       if (name == NULL || ((p = SMB_MALLOC_P(pcap_cache_t)) == NULL))
-               return False;
+       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;
 
-       p->next = pcap_cache;
-       pcap_cache = p;
+       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;
+       return true;
 }
 
-static void pcap_cache_destroy(pcap_cache_t *cache)
+void pcap_cache_destroy_specific(struct pcap_cache **pp_cache)
 {
-       pcap_cache_t *p, *next;
+       struct pcap_cache *p, *next;
 
-       for (p = cache; p != NULL; p = next) {
+       for (p = *pp_cache; p != NULL; p = next) {
                next = p->next;
 
                SAFE_FREE(p->name);
                SAFE_FREE(p->comment);
                SAFE_FREE(p);
        }
+       *pp_cache = NULL;
 }
 
-BOOL pcap_cache_loaded(void)
+bool pcap_cache_add(const char *name, const char *comment)
 {
-       return (pcap_cache != NULL);
+       NTSTATUS status;
+       time_t t = time_mono(NULL);
+
+       status = printer_list_set_printer(talloc_tos(), name, comment, t);
+       return NT_STATUS_IS_OK(status);
 }
 
-void pcap_cache_reload(void)
+bool pcap_cache_loaded(void)
+{
+       NTSTATUS status;
+       time_t last;
+
+       status = printer_list_get_last_refresh(&last);
+       return NT_STATUS_IS_OK(status);
+}
+
+void pcap_cache_replace(const struct pcap_cache *pcache)
+{
+       const struct pcap_cache *p;
+
+       for (p = pcache; p; p = p->next) {
+               pcap_cache_add(p->name, p->comment);
+       }
+}
+
+void pcap_cache_reload(struct tevent_context *ev,
+                      struct messaging_context *msg_ctx)
 {
        const char *pcap_name = lp_printcapname();
-       BOOL pcap_reloaded = False;
-       pcap_cache_t *tmp_cache = NULL;
-       XFILE *pcap_file;
-       char *pcap_line;
+       bool pcap_reloaded = False;
+       NTSTATUS status;
 
        DEBUG(3, ("reloading printcap cache\n"));
 
@@ -119,17 +121,33 @@ void pcap_cache_reload(void)
                return;
        }
 
-       tmp_cache = pcap_cache;
-       pcap_cache = NULL;
+       if (!printer_list_need_refresh()) {
+               /* has been just refeshed, skip */
+               DEBUG(5, ("Refresh just happend, skipping.\n"));
+               return;
+       }
+
+       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();
+               pcap_reloaded = cups_cache_reload(ev, msg_ctx);
                goto done;
        }
 #endif
 
-#ifdef SYSV
+#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;
@@ -143,111 +161,56 @@ void pcap_cache_reload(void)
        }
 #endif
 
-       /* 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, sizeof(pstring), pcap_file)) != NULL; safe_free(pcap_line)) {
-               pstring name, comment;
-               char *p, *q;
-
-               if (*pcap_line == '#' || *pcap_line == 0)
-                       continue;
-
-               /* now we have a real printer line - cut at the first : */      
-               if ((p = strchr_m(pcap_line, ':')) != NULL)
-                       *p = 0;
-      
-               /*
-                * 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) {
-                               pstrcpy(comment, p);
-                               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)) {
-                               pstrcpy(comment, p);
-                               continue;
-                       }
-               }
-
-               comment[60] = 0;
-               name[MAXPRINTERLEN] = 0;
-
-               if (*name && !pcap_cache_add(name, comment)) {
-                       x_fclose(pcap_file);
-                       goto done;
-               }
-       }
-
-       x_fclose(pcap_file);
-       pcap_reloaded = True;
+       pcap_reloaded = std_pcap_cache_reload(pcap_name);
 
 done:
        DEBUG(3, ("reload status: %s\n", (pcap_reloaded) ? "ok" : "error"));
 
-       if (pcap_reloaded)
-               pcap_cache_destroy(tmp_cache);
-       else {
-               pcap_cache_destroy(pcap_cache);
-               pcap_cache = tmp_cache;
+       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)
+bool pcap_printername_ok(const char *printername)
 {
-       pcap_cache_t *p;
+       NTSTATUS status;
 
-       for (p = pcap_cache; p != NULL; p = p->next)
-               if (strequal(p->name, printername))
-                       return True;
-
-       return False;
+       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). Note the fn() takes
-strings in DOS codepage. This means the xxx_printer_fn() calls must be fixed
-to return DOS codepage. FIXME !! JRA.
-
-XXX: I'm not sure if this comment still applies.. Anyone?  -Rob
+run a function on each printer name in the printcap file.
 ***************************************************************************/
-void pcap_printer_fn(void (*fn)(char *, char *))
+
+void pcap_printer_fn_specific(const struct pcap_cache *pc,
+                       void (*fn)(const char *, const char *, void *),
+                       void *pdata)
 {
-       pcap_cache_t *p;
+       const struct pcap_cache *p;
 
-       for (p = pcap_cache; p != NULL; p = p->next)
-               fn(p->name, p->comment);
+       for (p = pc; p != NULL; p = p->next)
+               fn(p->name, p->comment, pdata);
 
        return;
 }
+
+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;
+}