lib: Give lib/util/util_file.c its own header file
[samba.git] / source3 / printing / print_generic.c
index e1517c5dcb88a41172b30c9bdcfdd7169d9bbe68..a8bf9aff972527fb6337c6c139ffde5df68b4efe 100644 (file)
@@ -5,7 +5,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/>.
 */
 
+#include "includes.h"
+#include "lib/util/util_file.h"
 #include "printing.h"
+#include "smbd/proto.h"
+#include "source3/lib/substitute.h"
 
-
-/*
- * Generic printing interface definitions...
- */
-
-static int generic_job_delete(int snum, struct printjob *pjob);
-static int generic_job_pause(int snum, struct printjob *pjob);
-static int generic_job_resume(int snum, struct printjob *pjob);
-static int generic_job_submit(int snum, struct printjob *pjob);
-static int generic_queue_get(int snum, print_queue_struct **q,
-                             print_status_struct *status);
-static int generic_queue_pause(int snum);
-static int generic_queue_resume(int snum);
-
-
-struct printif generic_printif =
-               {
-                 generic_queue_get,
-                 generic_queue_pause,
-                 generic_queue_resume,
-                 generic_job_delete,
-                 generic_job_pause,
-                 generic_job_resume,
-                 generic_job_submit,
-               };
+extern userdom_struct current_user_info;
 
 /****************************************************************************
-run a given print command 
-a null terminated list of value/substitute pairs is provided
-for local substitution strings
+ Run a given print command
+ a null terminated list of value/substitute pairs is provided
+ for local substitution strings
 ****************************************************************************/
-static int print_run_command(int snum,char *command, int *outfd, ...)
+static int print_run_command(int snum, const char* printername, bool do_sub,
+                            const char *command, int *outfd, ...)
 {
-
-       pstring syscmd;
-       char *p, *arg;
+       const struct loadparm_substitution *lp_sub =
+               loadparm_s3_global_substitution();
+       char *syscmd;
+       char *arg;
        int ret;
+       TALLOC_CTX *ctx = talloc_tos();
        va_list ap;
        va_start(ap, outfd);
 
-       if (!command || !*command) return -1;
+       /* check for a valid system printername and valid command to run */
 
-       if (!VALID_SNUM(snum)) {
-               DEBUG(0,("Invalid snum %d for command %s\n", snum, command));
+       if ( !printername || !*printername ) {
+               va_end(ap);
                return -1;
        }
 
-       pstrcpy(syscmd, command);
+       if (!command || !*command) {
+               va_end(ap);
+               return -1;
+       }
+
+       syscmd = talloc_strdup(ctx, command);
+       if (!syscmd) {
+               va_end(ap);
+               return -1;
+       }
+
+       DBG_DEBUG("Incoming command '%s'\n", syscmd);
 
        while ((arg = va_arg(ap, char *))) {
                char *value = va_arg(ap,char *);
-               pstring_sub(syscmd, arg, value);
+               syscmd = talloc_string_sub(ctx, syscmd, arg, value);
+               if (!syscmd) {
+                       va_end(ap);
+                       return -1;
+               }
        }
        va_end(ap);
-  
-       p = PRINTERNAME(snum);
-  
-       pstring_sub(syscmd, "%p", p);
-       standard_sub_snum(snum,syscmd);
 
-       ret = smbrun(syscmd,outfd);
+       syscmd = talloc_string_sub(ctx, syscmd, "%p", printername);
+       if (!syscmd) {
+               return -1;
+       }
+
+       syscmd = lpcfg_substituted_string(ctx, lp_sub, syscmd);
+       if (syscmd == NULL) {
+               return -1;
+       }
+
+       if (do_sub && snum != -1) {
+               syscmd = talloc_sub_advanced(ctx,
+                               lp_servicename(talloc_tos(), lp_sub, snum),
+                               current_user_info.unix_name,
+                               "",
+                               get_current_gid(NULL),
+                               syscmd);
+               if (!syscmd) {
+                       return -1;
+               }
+       }
+
+       ret = smbrun_no_sanitize(syscmd, outfd, NULL);
 
        DEBUG(3,("Running the command `%s' gave %d\n",syscmd,ret));
 
@@ -91,17 +105,15 @@ static int print_run_command(int snum,char *command, int *outfd, ...)
 /****************************************************************************
 delete a print job
 ****************************************************************************/
-static int generic_job_delete(int snum, struct printjob *pjob)
+static int generic_job_delete( const char *sharename, const char *lprm_command, struct printjob *pjob)
 {
        fstring jobstr;
 
        /* need to delete the spooled entry */
-       slprintf(jobstr, sizeof(jobstr)-1, "%d", pjob->sysjob);
-       return print_run_command(
-                  snum, 
-                  lp_lprmcommand(snum), NULL,
+       fstr_sprintf(jobstr, "%d", pjob->sysjob);
+       return print_run_command( -1, sharename, False, lprm_command, NULL,
                   "%j", jobstr,
-                  "%T", http_timestring(pjob->starttime),
+                  "%T", http_timestring(talloc_tos(), pjob->starttime),
                   NULL);
 }
 
@@ -110,12 +122,14 @@ pause a job
 ****************************************************************************/
 static int generic_job_pause(int snum, struct printjob *pjob)
 {
+       const struct loadparm_substitution *lp_sub =
+               loadparm_s3_global_substitution();
        fstring jobstr;
        
        /* need to pause the spooled entry */
-       slprintf(jobstr, sizeof(jobstr)-1, "%d", pjob->sysjob);
-       return print_run_command(snum, 
-                                lp_lppausecommand(snum), NULL,
+       fstr_sprintf(jobstr, "%d", pjob->sysjob);
+       return print_run_command(snum, lp_printername(talloc_tos(), lp_sub, snum), True,
+                                lp_lppause_command(snum), NULL,
                                 "%j", jobstr,
                                 NULL);
 }
@@ -125,117 +139,194 @@ resume a job
 ****************************************************************************/
 static int generic_job_resume(int snum, struct printjob *pjob)
 {
+       const struct loadparm_substitution *lp_sub =
+               loadparm_s3_global_substitution();
        fstring jobstr;
-       
+
        /* need to pause the spooled entry */
-       slprintf(jobstr, sizeof(jobstr)-1, "%d", pjob->sysjob);
-       return print_run_command(snum, 
-                                lp_lpresumecommand(snum), NULL,
+       fstr_sprintf(jobstr, "%d", pjob->sysjob);
+       return print_run_command(snum, lp_printername(talloc_tos(), lp_sub, snum), True,
+                                lp_lpresume_command(snum), NULL,
                                 "%j", jobstr,
                                 NULL);
 }
 
-/****************************************************************************
- Submit a file for printing - called from print_job_end()
-****************************************************************************/
-
-static int generic_job_submit(int snum, struct printjob *pjob)
-{
-       int ret;
-       pstring current_directory;
-       pstring print_directory;
-       char *wd, *p;
-       pstring jobname;
-       fstring job_page_count, job_size;
-
-       /* we print from the directory path to give the best chance of
-           parsing the lpq output */
-       wd = sys_getwd(current_directory);
-       if (!wd)
-               return 0;
-
-       pstrcpy(print_directory, pjob->filename);
-       p = strrchr_m(print_directory,'/');
-       if (!p)
-               return 0;
-       *p++ = 0;
-
-       if (chdir(print_directory) != 0)
-               return 0;
-
-       pstrcpy(jobname, pjob->jobname);
-       pstring_sub(jobname, "'", "_");
-       slprintf(job_page_count, sizeof(job_page_count)-1, "%d", pjob->page_count);
-       slprintf(job_size, sizeof(job_size)-1, "%d", pjob->size);
-
-       /* send it to the system spooler */
-       ret = print_run_command(snum, 
-                       lp_printcommand(snum), NULL,
-                       "%s", p,
-                       "%J", jobname,
-                       "%f", p,
-                       "%z", job_size,
-                       "%c", job_page_count,
-                       NULL);
-
-       chdir(wd);
-
-        return ret;
-}
-
-
 /****************************************************************************
 get the current list of queued jobs
 ****************************************************************************/
-static int generic_queue_get(int snum, print_queue_struct **q, print_status_struct *status)
+static int generic_queue_get(const char *printer_name,
+                             enum printing_types printing_type,
+                             char *lpq_command,
+                             print_queue_struct **q,
+                             print_status_struct *status)
 {
        char **qlines;
        int fd;
        int numlines, i, qcount;
        print_queue_struct *queue = NULL;
-       fstring printer_name;
-              
-       fstrcpy(printer_name, lp_servicename(snum));
-       
-       print_run_command(snum, lp_lpqcommand(snum), &fd, NULL);
+
+       /* never do substitution when running the 'lpq command' since we can't
+          get it right when using the background update daemon.  Make the caller
+          do it before passing off the command string to us here. */
+
+       print_run_command(-1, printer_name, False, lpq_command, &fd, NULL);
 
        if (fd == -1) {
                DEBUG(5,("generic_queue_get: Can't read print queue status for printer %s\n",
                        printer_name ));
                return 0;
        }
-       
+
        numlines = 0;
-       qlines = fd_lines_load(fd, &numlines);
+       qlines = fd_lines_load(fd, &numlines,0,NULL);
        close(fd);
 
        /* turn the lpq output into a series of job structures */
        qcount = 0;
        ZERO_STRUCTP(status);
-       if (numlines)
-               queue = (print_queue_struct *)malloc(sizeof(print_queue_struct)*(numlines+1));
+       if (numlines && qlines) {
+               queue = SMB_MALLOC_ARRAY(print_queue_struct, numlines+1);
+               if (!queue) {
+                       TALLOC_FREE(qlines);
+                       *q = NULL;
+                       return 0;
+               }
+               memset(queue, '\0', sizeof(print_queue_struct)*(numlines+1));
 
-       if (queue) {
                for (i=0; i<numlines; i++) {
                        /* parse the line */
-                       if (parse_lpq_entry(snum,qlines[i],
+                       if (parse_lpq_entry(printing_type,qlines[i],
                                            &queue[qcount],status,qcount==0)) {
                                qcount++;
                        }
-               }               
+               }
        }
-       file_lines_free(qlines);
 
+       TALLOC_FREE(qlines);
         *q = queue;
        return qcount;
 }
 
+/****************************************************************************
+ Submit a file for printing - called from print_job_end()
+****************************************************************************/
+
+static int generic_job_submit(int snum, struct printjob *pjob,
+                             enum printing_types printing_type,
+                             char *lpq_cmd)
+{
+       int ret = -1;
+       const struct loadparm_substitution *lp_sub =
+               loadparm_s3_global_substitution();
+       char *current_directory = NULL;
+       char *print_directory = NULL;
+       char *wd = NULL;
+       char *p = NULL;
+       char *jobname = NULL;
+       TALLOC_CTX *ctx = talloc_tos();
+       fstring job_page_count, job_size;
+       print_queue_struct *q;
+       print_status_struct status;
+
+       /* we print from the directory path to give the best chance of
+           parsing the lpq output */
+       wd = sys_getwd();
+       if (!wd) {
+               return -1;
+       }
+
+       current_directory = talloc_strdup(ctx, wd);
+       SAFE_FREE(wd);
+
+       if (!current_directory) {
+               return -1;
+       }
+       print_directory = talloc_strdup(ctx, pjob->filename);
+       if (!print_directory) {
+               return -1;
+       }
+       p = strrchr_m(print_directory,'/');
+       if (!p) {
+               return -1;
+       }
+       *p++ = 0;
+
+       if (chdir(print_directory) != 0) {
+               return -1;
+       }
+
+       jobname = talloc_strdup(ctx, pjob->jobname);
+       if (!jobname) {
+               ret = -1;
+               goto out;
+       }
+       jobname = talloc_string_sub(ctx, jobname, "'", "_");
+       if (!jobname) {
+               ret = -1;
+               goto out;
+       }
+       fstr_sprintf(job_page_count, "%d", pjob->page_count);
+       fstr_sprintf(job_size, "%zu", pjob->size);
+
+       /* send it to the system spooler */
+       ret = print_run_command(snum, lp_printername(talloc_tos(), lp_sub, snum), True,
+                       lp_print_command(snum), NULL,
+                       "%s", p,
+                       "%J", jobname,
+                       "%f", p,
+                       "%z", job_size,
+                       "%c", job_page_count,
+                       NULL);
+       if (ret != 0) {
+               ret = -1;
+               goto out;
+       }
+
+       /*
+        * check the queue for the newly submitted job, this allows us to
+        * determine the backend job identifier (sysjob).
+        */
+       pjob->sysjob = -1;
+       ret = generic_queue_get(lp_printername(talloc_tos(), lp_sub, snum),
+                               printing_type, lpq_cmd, &q, &status);
+       if (ret > 0) {
+               int i;
+               for (i = 0; i < ret; i++) {
+                       if (strcmp(q[i].fs_file, p) == 0) {
+                               pjob->sysjob = q[i].sysjob;
+                               DEBUG(5, ("new job %u (%s) matches sysjob %d\n",
+                                         pjob->jobid, jobname, pjob->sysjob));
+                               break;
+                       }
+               }
+               SAFE_FREE(q);
+               ret = 0;
+       }
+       if (pjob->sysjob == -1) {
+               DEBUG(2, ("failed to get sysjob for job %u (%s), tracking as "
+                         "Unix job\n", pjob->jobid, jobname));
+       }
+
+
+ out:
+
+       if (chdir(current_directory) == -1) {
+               smb_panic("chdir failed in generic_job_submit");
+       }
+       TALLOC_FREE(current_directory);
+        return ret;
+}
+
 /****************************************************************************
  pause a queue
 ****************************************************************************/
 static int generic_queue_pause(int snum)
 {
-       return print_run_command(snum, lp_queuepausecommand(snum), NULL, NULL);
+       const struct loadparm_substitution *lp_sub =
+               loadparm_s3_global_substitution();
+
+       return print_run_command(snum, lp_printername(talloc_tos(), lp_sub, snum), True,
+                                lp_queuepause_command(snum), NULL, NULL);
 }
 
 /****************************************************************************
@@ -243,5 +334,26 @@ static int generic_queue_pause(int snum)
 ****************************************************************************/
 static int generic_queue_resume(int snum)
 {
-       return print_run_command(snum, lp_queueresumecommand(snum), NULL, NULL);
+       const struct loadparm_substitution *lp_sub =
+               loadparm_s3_global_substitution();
+
+       return print_run_command(snum, lp_printername(talloc_tos(), lp_sub, snum), True,
+                                lp_queueresume_command(snum), NULL, NULL);
 }
+
+/****************************************************************************
+ * Generic printing interface definitions...
+ ***************************************************************************/
+
+struct printif generic_printif =
+{
+       DEFAULT_PRINTING,
+       generic_queue_get,
+       generic_queue_pause,
+       generic_queue_resume,
+       generic_job_delete,
+       generic_job_pause,
+       generic_job_resume,
+       generic_job_submit,
+};
+