[thirdparty/cups.git] / scripting / php / phpcups.c

/*
 * "$Id: phpcups.c 6649 2007-07-11 21:46:42Z mike $"
 *
 *   Printing utilities for the Common UNIX Printing System (CUPS).
 *
 *   Copyright 2007 by Apple Inc.
 *   Copyright 1997-2007 by Easy Software Products.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Apple Inc. and are protected by Federal copyright
 *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
 *   which should have been included with this file.  If this file is
 *   file is missing or damaged, see the license at "http://www.cups.org/".
 *
 * Contents:
 *
 *   cups_convert_options()        - Convert a PHP options array to a CUPS options array.
 *   zm_startup_phpcups()          - Initialize the CUPS module.
 *   zif_cups_cancel_job()         - Cancel a job.
 *   zif_cups_get_dests()          - Get a list of printers and classes.
 *   zif_cups_get_jobs()           - Get a list of jobs.
 *   zif_cups_last_error()         - Return the last IPP status code.
 *   zif_cups_last_error_string()  - Return the last IPP status
 *   zif_cups_print_file()         - Print a single file.
 *   zif_cups_print_files()        - Print multiple files.
 */

/*
 * Include necessary headers...
 */

#include <cups/string.h>
#include "php.h"
#include "php_ini.h"
#include "ext/standard/info.h"
#include "phpcups.h"


/* 
 * PHP function list...
 */

function_entry phpcups_functions[] =
{
  PHP_FE(cups_cancel_job, NULL)
  PHP_FE(cups_get_dests, NULL)
  PHP_FE(cups_get_jobs, NULL)
  PHP_FE(cups_last_error, NULL)
  PHP_FE(cups_last_error_string, NULL)
  PHP_FE(cups_print_file, NULL)
  PHP_FE(cups_print_files, NULL)
  {NULL, NULL, NULL}
};


/*
 * PHP module info...
 */

zend_module_entry phpcups_module_entry =
{
  STANDARD_MODULE_HEADER,
  "phpcups",
  phpcups_functions,
  PHP_MINIT(phpcups),
  NULL,
  NULL,
  NULL,
  NULL,
  CUPS_SVERSION,
  STANDARD_MODULE_PROPERTIES
};


ZEND_GET_MODULE(phpcups)


/*
 * 'cups_convert_options()' - Convert a PHP options array to a CUPS options array.
 */

static int				/* O - Number of options */
cups_convert_options(
    zval          *optionsobj,		/* I - Options array object */
    cups_option_t **options)		/* O - Options */
{
  int		num_options;		/* Number of options */
  HashTable	*ht;			/* Option array hash table */
  Bucket	*current;		/* Current element in array */
  zval		*value;			/* Current value in array */
  char		temp[255];		/* String value for numbers */


  ht          = Z_ARRVAL_P(optionsobj);
  num_options = 0;

  for (current = ht->pListHead; current; current = current->pListNext)
  {
    value = (zval *)current->pDataPtr;

    switch (Z_TYPE_P(value))
    {
      case IS_LONG :
          sprintf(temp, "%ld", Z_LVAL_P(value));
          num_options = cupsAddOption(current->arKey, temp, num_options,
	                              options);
          break;

      case IS_DOUBLE :
          sprintf(temp, "%g", Z_DVAL_P(value));
          num_options = cupsAddOption(current->arKey, temp, num_options,
	                              options);
          break;

      case IS_BOOL :
          num_options = cupsAddOption(current->arKey,
	                              Z_BVAL_P(value) ? "true" : "false",
				      num_options, options);
          break;

      case IS_STRING :
          num_options = cupsAddOption(current->arKey, Z_STRVAL_P(value),
				      num_options, options);
          break;
    }
  }

  return (num_options);
}


/*
 * 'zm_startup_phpcups()' - Initialize the CUPS module.
 */

PHP_MINIT_FUNCTION(phpcups)
{
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_LOCAL", CUPS_PRINTER_LOCAL, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_CLASS", CUPS_PRINTER_CLASS, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_REMOTE", CUPS_PRINTER_REMOTE, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_BW", CUPS_PRINTER_BW, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_COLOR", CUPS_PRINTER_COLOR, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_DUPLEX", CUPS_PRINTER_DUPLEX, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_STAPLE", CUPS_PRINTER_STAPLE, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_COPIES", CUPS_PRINTER_COPIES, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_COLLATE", CUPS_PRINTER_COLLATE, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_PUNCH", CUPS_PRINTER_PUNCH, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_COVER", CUPS_PRINTER_COVER, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_BIND", CUPS_PRINTER_BIND, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_SORT", CUPS_PRINTER_SORT, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_SMALL", CUPS_PRINTER_SMALL, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_MEDIUM", CUPS_PRINTER_MEDIUM, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_LARGE", CUPS_PRINTER_LARGE, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_VARIABLE", CUPS_PRINTER_VARIABLE, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_IMPLICIT", CUPS_PRINTER_IMPLICIT, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_DEFAULT", CUPS_PRINTER_DEFAULT, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_FAX", CUPS_PRINTER_FAX, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_REJECTING", CUPS_PRINTER_REJECTING, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_DELETE", CUPS_PRINTER_DELETE, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_NOT_SHARED", CUPS_PRINTER_NOT_SHARED, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_AUTHENTICATED", CUPS_PRINTER_AUTHENTICATED, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_COMMANDS", CUPS_PRINTER_COMMANDS, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_DISCOVERED", CUPS_PRINTER_DISCOVERED, CONST_CS);
  REGISTER_LONG_CONSTANT("CUPS_PRINTER_OPTIONS", CUPS_PRINTER_OPTIONS, CONST_CS);

  REGISTER_LONG_CONSTANT("IPP_OK", IPP_OK, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_OK_SUBST", IPP_OK_SUBST, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_OK_CONFLICT", IPP_OK_CONFLICT, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_OK_IGNORED_SUBSCRIPTIONS", IPP_OK_IGNORED_SUBSCRIPTIONS, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_OK_IGNORED_NOTIFICATIONS", IPP_OK_IGNORED_NOTIFICATIONS, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_OK_TOO_MANY_EVENTS", IPP_OK_TOO_MANY_EVENTS, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_OK_BUT_CANCEL_SUBSCRIPTION", IPP_OK_BUT_CANCEL_SUBSCRIPTION, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_OK_EVENTS_COMPLETE", IPP_OK_EVENTS_COMPLETE, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_REDIRECTION_OTHER_SITE", IPP_REDIRECTION_OTHER_SITE, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_BAD_REQUEST", IPP_BAD_REQUEST, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_FORBIDDEN", IPP_FORBIDDEN, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_NOT_AUTHENTICATED", IPP_NOT_AUTHENTICATED, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_NOT_AUTHORIZED", IPP_NOT_AUTHORIZED, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_NOT_POSSIBLE", IPP_NOT_POSSIBLE, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_TIMEOUT", IPP_TIMEOUT, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_NOT_FOUND", IPP_NOT_FOUND, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_GONE", IPP_GONE, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_REQUEST_ENTITY", IPP_REQUEST_ENTITY, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_REQUEST_VALUE", IPP_REQUEST_VALUE, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_DOCUMENT_FORMAT", IPP_DOCUMENT_FORMAT, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_ATTRIBUTES", IPP_ATTRIBUTES, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_URI_SCHEME", IPP_URI_SCHEME, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_CHARSET", IPP_CHARSET, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_CONFLICT", IPP_CONFLICT, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_COMPRESSION_NOT_SUPPORTED", IPP_COMPRESSION_NOT_SUPPORTED, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_COMPRESSION_ERROR", IPP_COMPRESSION_ERROR, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_DOCUMENT_FORMAT_ERROR", IPP_DOCUMENT_FORMAT_ERROR, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_DOCUMENT_ACCESS_ERROR", IPP_DOCUMENT_ACCESS_ERROR, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_ATTRIBUTES_NOT_SETTABLE", IPP_ATTRIBUTES_NOT_SETTABLE, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_IGNORED_ALL_SUBSCRIPTIONS", IPP_IGNORED_ALL_SUBSCRIPTIONS, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_TOO_MANY_SUBSCRIPTIONS", IPP_TOO_MANY_SUBSCRIPTIONS, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_IGNORED_ALL_NOTIFICATIONS", IPP_IGNORED_ALL_NOTIFICATIONS, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_PRINT_SUPPORT_FILE_NOT_FOUND", IPP_PRINT_SUPPORT_FILE_NOT_FOUND, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_INTERNAL_ERROR", IPP_INTERNAL_ERROR, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_OPERATION_NOT_SUPPORTED", IPP_OPERATION_NOT_SUPPORTED, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_SERVICE_UNAVAILABLE", IPP_SERVICE_UNAVAILABLE, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_VERSION_NOT_SUPPORTED", IPP_VERSION_NOT_SUPPORTED, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_DEVICE_ERROR", IPP_DEVICE_ERROR, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_TEMPORARY_ERROR", IPP_TEMPORARY_ERROR, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_NOT_ACCEPTING", IPP_NOT_ACCEPTING, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_PRINTER_BUSY", IPP_PRINTER_BUSY, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_ERROR_JOB_CANCELLED", IPP_ERROR_JOB_CANCELLED, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_MULTIPLE_JOBS_NOT_SUPPORTED", IPP_MULTIPLE_JOBS_NOT_SUPPORTED, CONST_CS);
  REGISTER_LONG_CONSTANT("IPP_PRINTER_IS_DEACTIVATED", IPP_PRINTER_IS_DEACTIVATED, CONST_CS);

  return (SUCCESS);
}

/*
 * 'zif_cups_cancel_job()' - Cancel a job.
 */

PHP_FUNCTION(cups_cancel_job)
{
  char	*dest;				/* Destination */
  int	dest_len,			/* Length of destination */
	id;				/* Job ID */


  if (ZEND_NUM_ARGS() != 2 ||
      zend_parse_parameters(2, "sl", &dest, &dest_len, &id))
  {
    WRONG_PARAM_COUNT;
  }

  RETURN_LONG(cupsCancelJob(dest, id));
}


/*
 * 'zif_cups_get_dests()' - Get a list of printers and classes.
 */

PHP_FUNCTION(cups_get_dests)
{
  int		i, j,			/* Looping vars */
		num_dests;		/* Number of destinations */
  cups_dest_t	*dests,			/* Destinations */
		*dest;			/* Current destination */
  cups_option_t	*option;		/* Current option */
  zval		*destobj,		/* Destination object */
		*optionsobj;		/* Options object */


  if (ZEND_NUM_ARGS() != 0)
  {
    WRONG_PARAM_COUNT;
  }

  if ((num_dests = cupsGetDests(&dests)) <= 0)
  {
    RETURN_NULL();
  }

  if (array_init(return_value) == SUCCESS)
  {
    for (i = 0, dest = dests; i < num_dests; i ++, dest ++)
    {
      MAKE_STD_ZVAL(destobj);

      if (object_init(destobj) == SUCCESS)
      {
       /*
        * Add properties to the destination for each of the cups_dest_t
	* members...
	*/

        add_property_string(destobj, "name", dest->name, 1);
        add_property_string(destobj, "instance",
	                    dest->instance ? dest->instance : "", 1);
        add_property_long(destobj, "is_default", dest->is_default);

       /*
        * Create an associative array for the options...
	*/

        MAKE_STD_ZVAL(optionsobj);

	if (array_init(optionsobj) == SUCCESS)
	{
	  for (j = 0, option = dest->options;
	       j < dest->num_options;
	       j ++, option ++)
	    add_assoc_string(optionsobj, option->name, option->value, 1);

	  add_property_zval(destobj, "options", optionsobj);
	}

        add_index_zval(return_value, i, destobj);
      }
    }
  }

  cupsFreeDests(num_dests, dests);
}


/*
 * 'zif_cups_get_jobs()' - Get a list of jobs.
 */

PHP_FUNCTION(cups_get_jobs)
{
  char		*dest;			/* Destination */
  int		dest_len,		/* Length of destination */
		myjobs,			/* Only show my jobs? */
		completed;		/* Show completed jobs? */
  int		i,			/* Looping var */
		num_jobs;		/* Number of jobs */
  cups_job_t	*jobs,			/* Jobs */
		*job;			/* Current job */
  zval		*jobobj;		/* Job object */


  if (ZEND_NUM_ARGS() != 3 ||
      zend_parse_parameters(3, "sll", &dest, &dest_len, &myjobs, &completed))
  {
    WRONG_PARAM_COUNT;
  }

  if (!*dest)
    dest = NULL;

  if ((num_jobs = cupsGetJobs(&jobs, dest, myjobs, completed)) <= 0)
  {
    RETURN_NULL();
  }

  if (array_init(return_value) == SUCCESS)
  {
    for (i = 0, job = jobs; i < num_jobs; i ++, job ++)
    {
      MAKE_STD_ZVAL(jobobj);

      if (object_init(jobobj) == SUCCESS)
      {
       /*
        * Add properties to the job for each of the cups_job_t
	* members...
	*/

        add_property_long(jobobj, "id", job->id);
        add_property_string(jobobj, "dest", job->dest, 1);
        add_property_string(jobobj, "title", job->title, 1);
        add_property_string(jobobj, "user", job->user, 1);
        add_property_string(jobobj, "format", job->format, 1);
        add_property_long(jobobj, "state", job->state);
        add_property_long(jobobj, "size", job->size);
        add_property_long(jobobj, "priority", job->priority);
        add_property_long(jobobj, "completed_time", job->completed_time);
        add_property_long(jobobj, "creation_time", job->creation_time);
        add_property_long(jobobj, "processing_time", job->processing_time);

        add_index_zval(return_value, i, jobobj);
      }
    }
  }

  cupsFreeJobs(num_jobs, jobs);
}


/*
 * 'zif_cups_last_error()' - Return the last IPP status code.
 */

PHP_FUNCTION(cups_last_error)
{
  if (ZEND_NUM_ARGS() != 0)
  {
    WRONG_PARAM_COUNT;
  }

  RETURN_LONG(cupsLastError());
}


/*
 * 'zif_cups_last_error_string()' - Return the last IPP status-message.
 */

PHP_FUNCTION(cups_last_error_string)
{
  if (ZEND_NUM_ARGS() != 0)
  {
    WRONG_PARAM_COUNT;
  }

  RETURN_STRING((char *)cupsLastErrorString(), 1);
}


/*
 * 'zif_cups_print_file()' - Print a single file.
 */

PHP_FUNCTION(cups_print_file)
{
  char		*dest;			/* Destination */
  int		dest_len;		/* Length of destination */
  char		*filename;		/* Filename */
  int		filename_len;		/* Length of filename */
  char		*title;			/* Title */
  int		title_len;		/* Length of title */
  zval		*optionsobj;		/* Array of options */
  int		num_options;		/* Number of options */
  cups_option_t	*options;		/* Options */
  int		id;			/* Job ID */


  if (ZEND_NUM_ARGS() != 4 ||
      zend_parse_parameters(4, "sssa", &dest, &dest_len,
                            &filename, &filename_len,
			    &title, &title_len, &optionsobj))
  {
    WRONG_PARAM_COUNT;
  }

  num_options = cups_convert_options(optionsobj, &options);

  id = cupsPrintFile(dest, filename, title, num_options, options);

  cupsFreeOptions(num_options, options);

  RETURN_LONG(id);
}


/*
 * 'zif_cups_print_files()' - Print multiple files.
 */

PHP_FUNCTION(cups_print_files)
{
  char		*dest;			/* Destination */
  int		dest_len;		/* Length of destination */
  zval		*filesobj;		/* Files array */
  int		num_files;		/* Number of files */
  const char	*files[1000];		/* Files */
  char		*title;			/* Title */
  int		title_len;		/* Length of title */
  zval		*optionsobj;		/* Array of options */
  int		num_options;		/* Number of options */
  cups_option_t	*options;		/* Options */
  HashTable	*ht2;			/* Option array hash table */
  Bucket	*current;		/* Current element in array */
  int		id;			/* Job ID */


  if (ZEND_NUM_ARGS() != 4 ||
      zend_parse_parameters(4, "sasa", &dest, &dest_len, &filesobj,
			    &title, &title_len, &optionsobj))
  {
    WRONG_PARAM_COUNT;
  }

  ht2       = Z_ARRVAL_P(filesobj);
  num_files = 0;

  for (current = ht2->pListHead; current; current = current->pListNext)
  {
    files[num_files ++] = Z_STRVAL_P(((zval *)current->pDataPtr));

    if (num_files >= (int)(sizeof(files) / sizeof(files[0])))
      break;
  }

  num_options = cups_convert_options(optionsobj, &options);

  id = cupsPrintFiles(dest, num_files, files, title, num_options, options);

  cupsFreeOptions(num_options, options);

  RETURN_LONG(id);
}


/*
 * End of "$Id: phpcups.c 6649 2007-07-11 21:46:42Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
bc44d920	2	* "$Id: phpcups.c 6649 2007-07-11 21:46:42Z mike $"
ef416fc2	3	*
	4	* Printing utilities for the Common UNIX Printing System (CUPS).
	5	*
bc44d920	6	* Copyright 2007 by Apple Inc.
bc44d920	7	* Copyright 1997-2007 by Easy Software Products.
ef416fc2	8	*
ef416fc2	9	* These coded instructions, statements, and computer programs are the
bc44d920	10	* property of Apple Inc. and are protected by Federal copyright
	11	* law. Distribution and use rights are outlined in the file "LICENSE.txt"
	12	* which should have been included with this file. If this file is
	13	* file is missing or damaged, see the license at "http://www.cups.org/".
b423cd4c	14	*
	15	* Contents:
	16	*
bc44d920	17	* cups_convert_options() - Convert a PHP options array to a CUPS options array.
	18	* zm_startup_phpcups() - Initialize the CUPS module.
	19	* zif_cups_cancel_job() - Cancel a job.
	20	* zif_cups_get_dests() - Get a list of printers and classes.
	21	* zif_cups_get_jobs() - Get a list of jobs.
	22	* zif_cups_last_error() - Return the last IPP status code.
	23	* zif_cups_last_error_string() - Return the last IPP status
	24	* zif_cups_print_file() - Print a single file.
	25	* zif_cups_print_files() - Print multiple files.
ef416fc2	26	*/
ef416fc2	27
ef416fc2	28	/*
	29	* Include necessary headers...
	30	*/
	31
ef416fc2	32	#include <cups/string.h>
b423cd4c	33	#include "php.h"
	34	#include "php_ini.h"
	35	#include "ext/standard/info.h"
	36	#include "phpcups.h"
ef416fc2	37
ef416fc2	38
b423cd4c	39	/*
b423cd4c	40	* PHP function list...
ef416fc2	41	*/
ef416fc2	42
b423cd4c	43	function_entry phpcups_functions[] =
	44	{
	45	PHP_FE(cups_cancel_job, NULL)
	46	PHP_FE(cups_get_dests, NULL)
	47	PHP_FE(cups_get_jobs, NULL)
	48	PHP_FE(cups_last_error, NULL)
	49	PHP_FE(cups_last_error_string, NULL)
	50	PHP_FE(cups_print_file, NULL)
	51	PHP_FE(cups_print_files, NULL)
	52	{NULL, NULL, NULL}
	53	};
ef416fc2	54
	55
	56	/*
b423cd4c	57	* PHP module info...
ef416fc2	58	*/
ef416fc2	59
b423cd4c	60	zend_module_entry phpcups_module_entry =
	61	{
	62	STANDARD_MODULE_HEADER,
	63	"phpcups",
	64	phpcups_functions,
	65	PHP_MINIT(phpcups),
	66	NULL,
	67	NULL,
	68	NULL,
	69	NULL,
	70	CUPS_SVERSION,
	71	STANDARD_MODULE_PROPERTIES
ef416fc2	72	};
	73
	74
ef416fc2	75	ZEND_GET_MODULE(phpcups)
ef416fc2	76
ef416fc2	77
b423cd4c	78	/*
	79	* 'cups_convert_options()' - Convert a PHP options array to a CUPS options array.
	80	*/
ef416fc2	81
b423cd4c	82	static int /* O - Number of options */
	83	cups_convert_options(
	84	zval optionsobj, / I - Options array object */
	85	cups_option_t *options) / O - Options */
ef416fc2	86	{
b423cd4c	87	int num_options; /* Number of options */
	88	HashTable ht; / Option array hash table */
	89	Bucket current; / Current element in array */
bc44d920	90	zval value; / Current value in array */
bc44d920	91	char temp[255]; /* String value for numbers */
ef416fc2	92
ef416fc2	93
b423cd4c	94	ht = Z_ARRVAL_P(optionsobj);
b423cd4c	95	num_options = 0;
ef416fc2	96
b423cd4c	97	for (current = ht->pListHead; current; current = current->pListNext)
bc44d920	98	{
	99	value = (zval *)current->pDataPtr;
	100
	101	switch (Z_TYPE_P(value))
	102	{
	103	case IS_LONG :
	104	sprintf(temp, "%ld", Z_LVAL_P(value));
	105	num_options = cupsAddOption(current->arKey, temp, num_options,
	106	options);
	107	break;
	108
	109	case IS_DOUBLE :
	110	sprintf(temp, "%g", Z_DVAL_P(value));
	111	num_options = cupsAddOption(current->arKey, temp, num_options,
	112	options);
	113	break;
	114
	115	case IS_BOOL :
	116	num_options = cupsAddOption(current->arKey,
	117	Z_BVAL_P(value) ? "true" : "false",
	118	num_options, options);
	119	break;
	120
	121	case IS_STRING :
	122	num_options = cupsAddOption(current->arKey, Z_STRVAL_P(value),
	123	num_options, options);
	124	break;
	125	}
	126	}
ef416fc2	127
b423cd4c	128	return (num_options);
ef416fc2	129	}
ef416fc2	130
ef416fc2	131
b423cd4c	132	/*
	133	* 'zm_startup_phpcups()' - Initialize the CUPS module.
	134	*/
ef416fc2	135
b423cd4c	136	PHP_MINIT_FUNCTION(phpcups)
ef416fc2	137	{
b423cd4c	138	REGISTER_LONG_CONSTANT("CUPS_PRINTER_LOCAL", CUPS_PRINTER_LOCAL, CONST_CS);
	139	REGISTER_LONG_CONSTANT("CUPS_PRINTER_CLASS", CUPS_PRINTER_CLASS, CONST_CS);
	140	REGISTER_LONG_CONSTANT("CUPS_PRINTER_REMOTE", CUPS_PRINTER_REMOTE, CONST_CS);
	141	REGISTER_LONG_CONSTANT("CUPS_PRINTER_BW", CUPS_PRINTER_BW, CONST_CS);
	142	REGISTER_LONG_CONSTANT("CUPS_PRINTER_COLOR", CUPS_PRINTER_COLOR, CONST_CS);
	143	REGISTER_LONG_CONSTANT("CUPS_PRINTER_DUPLEX", CUPS_PRINTER_DUPLEX, CONST_CS);
	144	REGISTER_LONG_CONSTANT("CUPS_PRINTER_STAPLE", CUPS_PRINTER_STAPLE, CONST_CS);
	145	REGISTER_LONG_CONSTANT("CUPS_PRINTER_COPIES", CUPS_PRINTER_COPIES, CONST_CS);
	146	REGISTER_LONG_CONSTANT("CUPS_PRINTER_COLLATE", CUPS_PRINTER_COLLATE, CONST_CS);
	147	REGISTER_LONG_CONSTANT("CUPS_PRINTER_PUNCH", CUPS_PRINTER_PUNCH, CONST_CS);
	148	REGISTER_LONG_CONSTANT("CUPS_PRINTER_COVER", CUPS_PRINTER_COVER, CONST_CS);
	149	REGISTER_LONG_CONSTANT("CUPS_PRINTER_BIND", CUPS_PRINTER_BIND, CONST_CS);
	150	REGISTER_LONG_CONSTANT("CUPS_PRINTER_SORT", CUPS_PRINTER_SORT, CONST_CS);
	151	REGISTER_LONG_CONSTANT("CUPS_PRINTER_SMALL", CUPS_PRINTER_SMALL, CONST_CS);
	152	REGISTER_LONG_CONSTANT("CUPS_PRINTER_MEDIUM", CUPS_PRINTER_MEDIUM, CONST_CS);
	153	REGISTER_LONG_CONSTANT("CUPS_PRINTER_LARGE", CUPS_PRINTER_LARGE, CONST_CS);
	154	REGISTER_LONG_CONSTANT("CUPS_PRINTER_VARIABLE", CUPS_PRINTER_VARIABLE, CONST_CS);
	155	REGISTER_LONG_CONSTANT("CUPS_PRINTER_IMPLICIT", CUPS_PRINTER_IMPLICIT, CONST_CS);
	156	REGISTER_LONG_CONSTANT("CUPS_PRINTER_DEFAULT", CUPS_PRINTER_DEFAULT, CONST_CS);
	157	REGISTER_LONG_CONSTANT("CUPS_PRINTER_FAX", CUPS_PRINTER_FAX, CONST_CS);
	158	REGISTER_LONG_CONSTANT("CUPS_PRINTER_REJECTING", CUPS_PRINTER_REJECTING, CONST_CS);
	159	REGISTER_LONG_CONSTANT("CUPS_PRINTER_DELETE", CUPS_PRINTER_DELETE, CONST_CS);
	160	REGISTER_LONG_CONSTANT("CUPS_PRINTER_NOT_SHARED", CUPS_PRINTER_NOT_SHARED, CONST_CS);
	161	REGISTER_LONG_CONSTANT("CUPS_PRINTER_AUTHENTICATED", CUPS_PRINTER_AUTHENTICATED, CONST_CS);
	162	REGISTER_LONG_CONSTANT("CUPS_PRINTER_COMMANDS", CUPS_PRINTER_COMMANDS, CONST_CS);
bc44d920	163	REGISTER_LONG_CONSTANT("CUPS_PRINTER_DISCOVERED", CUPS_PRINTER_DISCOVERED, CONST_CS);
b423cd4c	164	REGISTER_LONG_CONSTANT("CUPS_PRINTER_OPTIONS", CUPS_PRINTER_OPTIONS, CONST_CS);
	165
	166	REGISTER_LONG_CONSTANT("IPP_OK", IPP_OK, CONST_CS);
	167	REGISTER_LONG_CONSTANT("IPP_OK_SUBST", IPP_OK_SUBST, CONST_CS);
	168	REGISTER_LONG_CONSTANT("IPP_OK_CONFLICT", IPP_OK_CONFLICT, CONST_CS);
	169	REGISTER_LONG_CONSTANT("IPP_OK_IGNORED_SUBSCRIPTIONS", IPP_OK_IGNORED_SUBSCRIPTIONS, CONST_CS);
	170	REGISTER_LONG_CONSTANT("IPP_OK_IGNORED_NOTIFICATIONS", IPP_OK_IGNORED_NOTIFICATIONS, CONST_CS);
	171	REGISTER_LONG_CONSTANT("IPP_OK_TOO_MANY_EVENTS", IPP_OK_TOO_MANY_EVENTS, CONST_CS);
	172	REGISTER_LONG_CONSTANT("IPP_OK_BUT_CANCEL_SUBSCRIPTION", IPP_OK_BUT_CANCEL_SUBSCRIPTION, CONST_CS);
	173	REGISTER_LONG_CONSTANT("IPP_OK_EVENTS_COMPLETE", IPP_OK_EVENTS_COMPLETE, CONST_CS);
	174	REGISTER_LONG_CONSTANT("IPP_REDIRECTION_OTHER_SITE", IPP_REDIRECTION_OTHER_SITE, CONST_CS);
	175	REGISTER_LONG_CONSTANT("IPP_BAD_REQUEST", IPP_BAD_REQUEST, CONST_CS);
	176	REGISTER_LONG_CONSTANT("IPP_FORBIDDEN", IPP_FORBIDDEN, CONST_CS);
	177	REGISTER_LONG_CONSTANT("IPP_NOT_AUTHENTICATED", IPP_NOT_AUTHENTICATED, CONST_CS);
	178	REGISTER_LONG_CONSTANT("IPP_NOT_AUTHORIZED", IPP_NOT_AUTHORIZED, CONST_CS);
	179	REGISTER_LONG_CONSTANT("IPP_NOT_POSSIBLE", IPP_NOT_POSSIBLE, CONST_CS);
	180	REGISTER_LONG_CONSTANT("IPP_TIMEOUT", IPP_TIMEOUT, CONST_CS);
	181	REGISTER_LONG_CONSTANT("IPP_NOT_FOUND", IPP_NOT_FOUND, CONST_CS);
	182	REGISTER_LONG_CONSTANT("IPP_GONE", IPP_GONE, CONST_CS);
	183	REGISTER_LONG_CONSTANT("IPP_REQUEST_ENTITY", IPP_REQUEST_ENTITY, CONST_CS);
	184	REGISTER_LONG_CONSTANT("IPP_REQUEST_VALUE", IPP_REQUEST_VALUE, CONST_CS);
	185	REGISTER_LONG_CONSTANT("IPP_DOCUMENT_FORMAT", IPP_DOCUMENT_FORMAT, CONST_CS);
	186	REGISTER_LONG_CONSTANT("IPP_ATTRIBUTES", IPP_ATTRIBUTES, CONST_CS);
	187	REGISTER_LONG_CONSTANT("IPP_URI_SCHEME", IPP_URI_SCHEME, CONST_CS);
	188	REGISTER_LONG_CONSTANT("IPP_CHARSET", IPP_CHARSET, CONST_CS);
	189	REGISTER_LONG_CONSTANT("IPP_CONFLICT", IPP_CONFLICT, CONST_CS);
	190	REGISTER_LONG_CONSTANT("IPP_COMPRESSION_NOT_SUPPORTED", IPP_COMPRESSION_NOT_SUPPORTED, CONST_CS);
	191	REGISTER_LONG_CONSTANT("IPP_COMPRESSION_ERROR", IPP_COMPRESSION_ERROR, CONST_CS);
	192	REGISTER_LONG_CONSTANT("IPP_DOCUMENT_FORMAT_ERROR", IPP_DOCUMENT_FORMAT_ERROR, CONST_CS);
	193	REGISTER_LONG_CONSTANT("IPP_DOCUMENT_ACCESS_ERROR", IPP_DOCUMENT_ACCESS_ERROR, CONST_CS);
	194	REGISTER_LONG_CONSTANT("IPP_ATTRIBUTES_NOT_SETTABLE", IPP_ATTRIBUTES_NOT_SETTABLE, CONST_CS);
	195	REGISTER_LONG_CONSTANT("IPP_IGNORED_ALL_SUBSCRIPTIONS", IPP_IGNORED_ALL_SUBSCRIPTIONS, CONST_CS);
	196	REGISTER_LONG_CONSTANT("IPP_TOO_MANY_SUBSCRIPTIONS", IPP_TOO_MANY_SUBSCRIPTIONS, CONST_CS);
	197	REGISTER_LONG_CONSTANT("IPP_IGNORED_ALL_NOTIFICATIONS", IPP_IGNORED_ALL_NOTIFICATIONS, CONST_CS);
	198	REGISTER_LONG_CONSTANT("IPP_PRINT_SUPPORT_FILE_NOT_FOUND", IPP_PRINT_SUPPORT_FILE_NOT_FOUND, CONST_CS);
	199	REGISTER_LONG_CONSTANT("IPP_INTERNAL_ERROR", IPP_INTERNAL_ERROR, CONST_CS);
	200	REGISTER_LONG_CONSTANT("IPP_OPERATION_NOT_SUPPORTED", IPP_OPERATION_NOT_SUPPORTED, CONST_CS);
	201	REGISTER_LONG_CONSTANT("IPP_SERVICE_UNAVAILABLE", IPP_SERVICE_UNAVAILABLE, CONST_CS);
	202	REGISTER_LONG_CONSTANT("IPP_VERSION_NOT_SUPPORTED", IPP_VERSION_NOT_SUPPORTED, CONST_CS);
	203	REGISTER_LONG_CONSTANT("IPP_DEVICE_ERROR", IPP_DEVICE_ERROR, CONST_CS);
	204	REGISTER_LONG_CONSTANT("IPP_TEMPORARY_ERROR", IPP_TEMPORARY_ERROR, CONST_CS);
	205	REGISTER_LONG_CONSTANT("IPP_NOT_ACCEPTING", IPP_NOT_ACCEPTING, CONST_CS);
	206	REGISTER_LONG_CONSTANT("IPP_PRINTER_BUSY", IPP_PRINTER_BUSY, CONST_CS);
	207	REGISTER_LONG_CONSTANT("IPP_ERROR_JOB_CANCELLED", IPP_ERROR_JOB_CANCELLED, CONST_CS);
	208	REGISTER_LONG_CONSTANT("IPP_MULTIPLE_JOBS_NOT_SUPPORTED", IPP_MULTIPLE_JOBS_NOT_SUPPORTED, CONST_CS);
	209	REGISTER_LONG_CONSTANT("IPP_PRINTER_IS_DEACTIVATED", IPP_PRINTER_IS_DEACTIVATED, CONST_CS);
	210
	211	return (SUCCESS);
ef416fc2	212	}
ef416fc2	213
b423cd4c	214	/*
	215	* 'zif_cups_cancel_job()' - Cancel a job.
	216	*/
ef416fc2	217
b423cd4c	218	PHP_FUNCTION(cups_cancel_job)
ef416fc2	219	{
b423cd4c	220	char dest; / Destination */
	221	int dest_len, /* Length of destination */
	222	id; /* Job ID */
ef416fc2	223
ef416fc2	224
b423cd4c	225	if (ZEND_NUM_ARGS() != 2 \|\|
	226	zend_parse_parameters(2, "sl", &dest, &dest_len, &id))
	227	{
	228	WRONG_PARAM_COUNT;
	229	}
ef416fc2	230
b423cd4c	231	RETURN_LONG(cupsCancelJob(dest, id));
ef416fc2	232	}
ef416fc2	233
	234
	235	/*
bc44d920	236	* 'zif_cups_get_dests()' - Get a list of printers and classes.
ef416fc2	237	*/
ef416fc2	238
b423cd4c	239	PHP_FUNCTION(cups_get_dests)
	240	{
	241	int i, j, /* Looping vars */
	242	num_dests; /* Number of destinations */
	243	cups_dest_t dests, / Destinations */
	244	dest; / Current destination */
	245	cups_option_t option; / Current option */
	246	zval destobj, / Destination object */
	247	optionsobj; / Options object */
ef416fc2	248
ef416fc2	249
b423cd4c	250	if (ZEND_NUM_ARGS() != 0)
	251	{
	252	WRONG_PARAM_COUNT;
	253	}
ef416fc2	254
b423cd4c	255	if ((num_dests = cupsGetDests(&dests)) <= 0)
	256	{
	257	RETURN_NULL();
	258	}
ef416fc2	259
b423cd4c	260	if (array_init(return_value) == SUCCESS)
	261	{
	262	for (i = 0, dest = dests; i < num_dests; i ++, dest ++)
ef416fc2	263	{
b423cd4c	264	MAKE_STD_ZVAL(destobj);
ef416fc2	265
b423cd4c	266	if (object_init(destobj) == SUCCESS)
ef416fc2	267	{
b423cd4c	268	/*
	269	* Add properties to the destination for each of the cups_dest_t
	270	* members...
	271	*/
ef416fc2	272
b423cd4c	273	add_property_string(destobj, "name", dest->name, 1);
	274	add_property_string(destobj, "instance",
	275	dest->instance ? dest->instance : "", 1);
	276	add_property_long(destobj, "is_default", dest->is_default);
ef416fc2	277
b423cd4c	278	/*
	279	* Create an associative array for the options...
	280	*/
ef416fc2	281
b423cd4c	282	MAKE_STD_ZVAL(optionsobj);
ef416fc2	283
b423cd4c	284	if (array_init(optionsobj) == SUCCESS)
	285	{
	286	for (j = 0, option = dest->options;
	287	j < dest->num_options;
	288	j ++, option ++)
	289	add_assoc_string(optionsobj, option->name, option->value, 1);
ef416fc2	290
b423cd4c	291	add_property_zval(destobj, "options", optionsobj);
b423cd4c	292	}
ef416fc2	293
b423cd4c	294	add_index_zval(return_value, i, destobj);
ef416fc2	295	}
ef416fc2	296	}
b423cd4c	297	}
ef416fc2	298
b423cd4c	299	cupsFreeDests(num_dests, dests);
ef416fc2	300	}
	301
	302
ef416fc2	303	/*
b423cd4c	304	* 'zif_cups_get_jobs()' - Get a list of jobs.
ef416fc2	305	*/
ef416fc2	306
b423cd4c	307	PHP_FUNCTION(cups_get_jobs)
	308	{
	309	char dest; / Destination */
	310	int dest_len, /* Length of destination */
	311	myjobs, /* Only show my jobs? */
	312	completed; /* Show completed jobs? */
	313	int i, /* Looping var */
	314	num_jobs; /* Number of jobs */
	315	cups_job_t jobs, / Jobs */
	316	job; / Current job */
	317	zval jobobj; / Job object */
ef416fc2	318
ef416fc2	319
ef416fc2	320
ef416fc2	321
b423cd4c	322	if (ZEND_NUM_ARGS() != 3 \|\|
	323	zend_parse_parameters(3, "sll", &dest, &dest_len, &myjobs, &completed))
	324	{
	325	WRONG_PARAM_COUNT;
	326	}
ef416fc2	327
b423cd4c	328	if (!*dest)
b423cd4c	329	dest = NULL;
ef416fc2	330
b423cd4c	331	if ((num_jobs = cupsGetJobs(&jobs, dest, myjobs, completed)) <= 0)
	332	{
	333	RETURN_NULL();
	334	}
ef416fc2	335
b423cd4c	336	if (array_init(return_value) == SUCCESS)
	337	{
	338	for (i = 0, job = jobs; i < num_jobs; i ++, job ++)
ef416fc2	339	{
b423cd4c	340	MAKE_STD_ZVAL(jobobj);
ef416fc2	341
b423cd4c	342	if (object_init(jobobj) == SUCCESS)
ef416fc2	343	{
b423cd4c	344	/*
	345	* Add properties to the job for each of the cups_job_t
	346	* members...
	347	*/
	348
	349	add_property_long(jobobj, "id", job->id);
	350	add_property_string(jobobj, "dest", job->dest, 1);
	351	add_property_string(jobobj, "title", job->title, 1);
	352	add_property_string(jobobj, "user", job->user, 1);
	353	add_property_string(jobobj, "format", job->format, 1);
	354	add_property_long(jobobj, "state", job->state);
	355	add_property_long(jobobj, "size", job->size);
	356	add_property_long(jobobj, "priority", job->priority);
	357	add_property_long(jobobj, "completed_time", job->completed_time);
	358	add_property_long(jobobj, "creation_time", job->creation_time);
	359	add_property_long(jobobj, "processing_time", job->processing_time);
	360
	361	add_index_zval(return_value, i, jobobj);
ef416fc2	362	}
ef416fc2	363	}
b423cd4c	364	}
ef416fc2	365
b423cd4c	366	cupsFreeJobs(num_jobs, jobs);
b423cd4c	367	}
ef416fc2	368
	369
	370	/*
b423cd4c	371	* 'zif_cups_last_error()' - Return the last IPP status code.
ef416fc2	372	*/
b423cd4c	373
ef416fc2	374	PHP_FUNCTION(cups_last_error)
ef416fc2	375	{
b423cd4c	376	if (ZEND_NUM_ARGS() != 0)
ef416fc2	377	{
b423cd4c	378	WRONG_PARAM_COUNT;
ef416fc2	379	}
ef416fc2	380
b423cd4c	381	RETURN_LONG(cupsLastError());
ef416fc2	382	}
	383
	384
ef416fc2	385	/*
b423cd4c	386	* 'zif_cups_last_error_string()' - Return the last IPP status-message.
ef416fc2	387	*/
ef416fc2	388
b423cd4c	389	PHP_FUNCTION(cups_last_error_string)
ef416fc2	390	{
b423cd4c	391	if (ZEND_NUM_ARGS() != 0)
ef416fc2	392	{
b423cd4c	393	WRONG_PARAM_COUNT;
ef416fc2	394	}
ef416fc2	395
b423cd4c	396	RETURN_STRING((char *)cupsLastErrorString(), 1);
ef416fc2	397	}
	398
	399
ef416fc2	400	/*
b423cd4c	401	* 'zif_cups_print_file()' - Print a single file.
ef416fc2	402	*/
ef416fc2	403
b423cd4c	404	PHP_FUNCTION(cups_print_file)
ef416fc2	405	{
b423cd4c	406	char dest; / Destination */
	407	int dest_len; /* Length of destination */
	408	char filename; / Filename */
	409	int filename_len; /* Length of filename */
	410	char title; / Title */
	411	int title_len; /* Length of title */
	412	zval optionsobj; / Array of options */
	413	int num_options; /* Number of options */
	414	cups_option_t options; / Options */
	415	int id; /* Job ID */
	416
	417
	418	if (ZEND_NUM_ARGS() != 4 \|\|
	419	zend_parse_parameters(4, "sssa", &dest, &dest_len,
	420	&filename, &filename_len,
	421	&title, &title_len, &optionsobj))
ef416fc2	422	{
b423cd4c	423	WRONG_PARAM_COUNT;
ef416fc2	424	}
ef416fc2	425
b423cd4c	426	num_options = cups_convert_options(optionsobj, &options);
ef416fc2	427
b423cd4c	428	id = cupsPrintFile(dest, filename, title, num_options, options);
ef416fc2	429
b423cd4c	430	cupsFreeOptions(num_options, options);
ef416fc2	431
b423cd4c	432	RETURN_LONG(id);
ef416fc2	433	}
	434
	435
b423cd4c	436	/*
	437	* 'zif_cups_print_files()' - Print multiple files.
	438	*/
ef416fc2	439
b423cd4c	440	PHP_FUNCTION(cups_print_files)
ef416fc2	441	{
b423cd4c	442	char dest; / Destination */
	443	int dest_len; /* Length of destination */
	444	zval filesobj; / Files array */
	445	int num_files; /* Number of files */
	446	const char files[1000]; / Files */
	447	char title; / Title */
	448	int title_len; /* Length of title */
	449	zval optionsobj; / Array of options */
	450	int num_options; /* Number of options */
	451	cups_option_t options; / Options */
	452	HashTable ht2; / Option array hash table */
	453	Bucket current; / Current element in array */
	454	int id; /* Job ID */
	455
	456
	457	if (ZEND_NUM_ARGS() != 4 \|\|
	458	zend_parse_parameters(4, "sasa", &dest, &dest_len, &filesobj,
	459	&title, &title_len, &optionsobj))
ef416fc2	460	{
b423cd4c	461	WRONG_PARAM_COUNT;
ef416fc2	462	}
ef416fc2	463
b423cd4c	464	ht2 = Z_ARRVAL_P(filesobj);
b423cd4c	465	num_files = 0;
ef416fc2	466
b423cd4c	467	for (current = ht2->pListHead; current; current = current->pListNext)
ef416fc2	468	{
b423cd4c	469	files[num_files ++] = Z_STRVAL_P(((zval *)current->pDataPtr));
ef416fc2	470
b423cd4c	471	if (num_files >= (int)(sizeof(files) / sizeof(files[0])))
b423cd4c	472	break;
ef416fc2	473	}
ef416fc2	474
b423cd4c	475	num_options = cups_convert_options(optionsobj, &options);
ef416fc2	476
b423cd4c	477	id = cupsPrintFiles(dest, num_files, files, title, num_options, options);
ef416fc2	478
b423cd4c	479	cupsFreeOptions(num_options, options);
ef416fc2	480
b423cd4c	481	RETURN_LONG(id);
ef416fc2	482	}
	483
	484
ef416fc2	485	/*
bc44d920	486	* End of "$Id: phpcups.c 6649 2007-07-11 21:46:42Z mike $".
ef416fc2	487	*/