source3/printing/printer_list.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Share Database of available printers.
   4    Copyright (C) Simo Sorce 2010
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef _PRINTER_LIST_H_
  21 #define _PRINTER_LIST_H_
  22
  23 bool printer_list_parent_init(void);
  24
  25 /**
  26  * @brief Get the comment and the last refresh time from the printer list
  27  *        database.
  28  *
  29  * @param[in]  mem_ctx  The talloc memory context to use.
  30  *
  31  * @param[in]  name     The printer name to lookup.
  32  *
  33  * @param[out] comment  A pointer to store the comment of the printer.
  34  *
  35  * @param[out] last_refresh A pointer to store the last refresh time of the
  36  *                          printer.
  37  *
  38  * @return              NT_STATUS_OK on success, a correspoining NTSTATUS error
  39  *                      code on a failure.
  40  */
  41 NTSTATUS printer_list_get_printer(TALLOC_CTX *mem_ctx,
  42                                   const char *name,
  43                                   const char **comment,
  44                                   time_t *last_refresh);
  45
  46 /**
  47  * @brief Add a printer to the printer list database.
  48  *
  49  * @param[in]  mem_ctx  The talloc memory context to use.
  50  *
  51  * @param[in]  name     The printer name to store in the db.
  52  *
  53  * @param[in]  comment  The comment to store in the db.
  54  *
  55  * @param[in]  last_refresh The last refresh time of the printer to store in
  56  *                          the db.
  57  *
  58  * @return              NT_STATUS_OK on success, a correspoining NTSTATUS error
  59  *                      code on a failure.
  60  */
  61 NTSTATUS printer_list_set_printer(TALLOC_CTX *mem_ctx,
  62                                   const char *name,
  63                                   const char *comment,
  64                                   time_t last_refresh);
  65
  66 /**
  67  * @brief Get the time of the last refresh of the printer database.
  68  *
  69  * @param[out] last_refresh The last refresh time in the db.
  70  *
  71  * @return              NT_STATUS_OK on success, a correspoining NTSTATUS error
  72  *                      code on a failure.
  73  */
  74 NTSTATUS printer_list_get_last_refresh(time_t *last_refresh);
  75
  76 /**
  77  * @brief Mark the database as reloaded.
  78  *
  79  * This sets the last refresh time to the current time. You can get the last
  80  * reload/refresh time of the database with printer_list_get_last_refresh().
  81  *
  82  * @return              NT_STATUS_OK on success, a correspoining NTSTATUS error
  83  *                      code on a failure.
  84  */
  85 NTSTATUS printer_list_mark_reload(void);
  86
  87 /**
  88  * @brief Cleanup old entries in the database.
  89  *
  90  * Entries older than the last refresh times will be deleted.
  91  *
  92  * @return              NT_STATUS_OK on success, a correspoining NTSTATUS error
  93  *                      code on a failure.
  94  */
  95 NTSTATUS printer_list_clean_old(void);
  96
  97 NTSTATUS printer_list_run_fn(void (*fn)(const char *, const char *, void *),
  98                              void *private_data);
  99
 100 /**
 101  * @brief Check if the printer list needs to be refreshed.
 102  *
 103  * @return              True if the database needs to be refreshed, false if
 104  *                      not.
 105  */
 106 bool printer_list_need_refresh(void);
 107
 108 #endif /* _PRINTER_LIST_H_ */