[thirdparty/cups.git] / scheduler / quotas.c

/*
 * "$Id: quotas.c 6365 2007-03-19 20:56:57Z mike $"
 *
 *   Quota routines for the Common UNIX Printing System (CUPS).
 *
 *   Copyright 1997-2007 by Easy Software Products.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Easy Software Products 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 missing or damaged please contact Easy Software Products
 *   at:
 *
 *       Attn: CUPS Licensing Information
 *       Easy Software Products
 *       44141 Airport View Drive, Suite 204
 *       Hollywood, Maryland 20636 USA
 *
 *       Voice: (301) 373-9600
 *       EMail: cups-info@cups.org
 *         WWW: http://www.cups.org
 *
 * Contents:
 *
 *   cupsdFreeQuotas()  - Free quotas for a printer.
 *   cupsdUpdateQuota() - Update quota data for the specified printer and user.
 *   add_quota()        - Add a quota record for this printer and user.
 *   compare_quotas()   - Compare two quota records...
 *   find_quota()       - Find a quota record.
 */

/*
 * Include necessary headers...
 */

#include "cupsd.h"


/*
 * Local functions...
 */

static cupsd_quota_t	*add_quota(cupsd_printer_t *p, const char *username);
static int		compare_quotas(const cupsd_quota_t *q1,
			               const cupsd_quota_t *q2);
static cupsd_quota_t	*find_quota(cupsd_printer_t *p, const char *username);


/*
 * 'cupsdFreeQuotas()' - Free quotas for a printer.
 */

void
cupsdFreeQuotas(cupsd_printer_t *p)	/* I - Printer */
{
  cupsd_quota_t *q;			/* Current quota record */


  if (!p)
    return;

  for (q = (cupsd_quota_t *)cupsArrayFirst(p->quotas);
       q;
       q = (cupsd_quota_t *)cupsArrayNext(p->quotas))
    free(q);

  cupsArrayDelete(p->quotas);

  p->quotas = NULL;
}


/*
 * 'cupsdUpdateQuota()' - Update quota data for the specified printer and user.
 */

cupsd_quota_t *				/* O - Quota data */
cupsdUpdateQuota(
    cupsd_printer_t *p,			/* I - Printer */
    const char      *username,		/* I - User */
    int             pages,		/* I - Number of pages */
    int             k)			/* I - Number of kilobytes */
{
  cupsd_quota_t		*q;		/* Quota data */
  cupsd_job_t		*job;		/* Current job */
  time_t		curtime;	/* Current time */
  ipp_attribute_t	*attr;		/* Job attribute */


  if (!p || !username)
    return (NULL);

  if (!p->k_limit && !p->page_limit)
    return (NULL);

  if ((q = find_quota(p, username)) == NULL)
    return (NULL);

  cupsdLogMessage(CUPSD_LOG_DEBUG,
                  "cupsdUpdateQuota: p=%s username=%s pages=%d k=%d",
                  p->name, username, pages, k);

#if defined(__APPLE__) && defined(HAVE_DLFCN_H)
 /*
  * Use Apple PrintService quota enforcement if installed (X Server only)
  */

  if (AppleQuotas && PSQUpdateQuotaProc)
  { 
    q->page_count = (*PSQUpdateQuotaProc)(p->name, p->info, username, pages, 0);

    return (q);
  }
#endif /* __APPLE__ && HAVE_DLFCN_H */

  curtime = time(NULL);

  if (curtime < q->next_update)
  {
    q->page_count += pages;
    q->k_count    += k;

    return (q);
  }

  if (p->quota_period)
    curtime -= p->quota_period;
  else
    curtime = 0;

  q->next_update = 0;
  q->page_count  = 0;
  q->k_count     = 0;

  for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
       job;
       job = (cupsd_job_t *)cupsArrayNext(Jobs))
  {
    if (strcasecmp(job->dest, p->name) != 0 ||
        strcasecmp(job->username, q->username) != 0)
      continue;

    if ((attr = ippFindAttribute(job->attrs, "time-at-completion",
                                 IPP_TAG_INTEGER)) == NULL)
      if ((attr = ippFindAttribute(job->attrs, "time-at-processing",
                                   IPP_TAG_INTEGER)) == NULL)
        attr = ippFindAttribute(job->attrs, "time-at-creation",
                                IPP_TAG_INTEGER);

    if (attr == NULL)
      break;

    if (attr->values[0].integer < curtime)
    {
      if (JobAutoPurge)
        cupsdCancelJob(job, 1, IPP_JOB_CANCELED);

      continue;
    }

    if (q->next_update == 0)
      q->next_update = attr->values[0].integer + p->quota_period;

    if ((attr = ippFindAttribute(job->attrs, "job-media-sheets-completed",
                                 IPP_TAG_INTEGER)) != NULL)
      q->page_count += attr->values[0].integer;

    if ((attr = ippFindAttribute(job->attrs, "job-k-octets",
                                 IPP_TAG_INTEGER)) != NULL)
      q->k_count += attr->values[0].integer;
  }

  return (q);
}


/*
 * 'add_quota()' - Add a quota record for this printer and user.
 */

static cupsd_quota_t *			/* O - Quota data */
add_quota(cupsd_printer_t *p,		/* I - Printer */
          const char      *username)	/* I - User */
{
  cupsd_quota_t	*q;			/* New quota data */


  if (!p || !username)
    return (NULL);

  if (!p->quotas)
    p->quotas = cupsArrayNew((cups_array_func_t)compare_quotas, NULL);

  if (!p->quotas)
    return (NULL);

  if ((q = calloc(1, sizeof(cupsd_quota_t))) == NULL)
    return (NULL);

  strlcpy(q->username, username, sizeof(q->username));

  cupsArrayAdd(p->quotas, q);

  return (q);
}


/*
 * 'compare_quotas()' - Compare two quota records...
 */

static int				/* O - Result of comparison */
compare_quotas(const cupsd_quota_t *q1,	/* I - First quota record */
               const cupsd_quota_t *q2)	/* I - Second quota record */
{
  return (strcasecmp(q1->username, q2->username));
}


/*
 * 'find_quota()' - Find a quota record.
 */

static cupsd_quota_t *			/* O - Quota data */
find_quota(cupsd_printer_t *p,		/* I - Printer */
           const char      *username)	/* I - User */
{
  cupsd_quota_t	*q,			/* Quota data pointer */
		match;			/* Search data */


  if (!p || !username)
    return (NULL);

  strlcpy(match.username, username, sizeof(match.username));

  if ((q = (cupsd_quota_t *)cupsArrayFind(p->quotas, &match)) != NULL)
    return (q);
  else
    return (add_quota(p, username));
}


/*
 * End of "$Id: quotas.c 6365 2007-03-19 20:56:57Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
7594b224	2	* "$Id: quotas.c 6365 2007-03-19 20:56:57Z mike $"
ef416fc2	3	*
	4	* Quota routines for the Common UNIX Printing System (CUPS).
	5	*
7594b224	6	* Copyright 1997-2007 by Easy Software Products.
ef416fc2	7	*
	8	* These coded instructions, statements, and computer programs are the
	9	* property of Easy Software Products and are protected by Federal
	10	* copyright law. Distribution and use rights are outlined in the file
	11	* "LICENSE.txt" which should have been included with this file. If this
	12	* file is missing or damaged please contact Easy Software Products
	13	* at:
	14	*
	15	* Attn: CUPS Licensing Information
	16	* Easy Software Products
	17	* 44141 Airport View Drive, Suite 204
	18	* Hollywood, Maryland 20636 USA
	19	*
	20	* Voice: (301) 373-9600
	21	* EMail: cups-info@cups.org
	22	* WWW: http://www.cups.org
	23	*
	24	* Contents:
	25	*
ef416fc2	26	* cupsdFreeQuotas() - Free quotas for a printer.
ef416fc2	27	* cupsdUpdateQuota() - Update quota data for the specified printer and user.
e1d6a774	28	* add_quota() - Add a quota record for this printer and user.
fa73b229	29	* compare_quotas() - Compare two quota records...
e1d6a774	30	* find_quota() - Find a quota record.
ef416fc2	31	*/
	32
	33	/*
	34	* Include necessary headers...
	35	*/
	36
	37	#include "cupsd.h"
	38
	39
	40	/*
	41	* Local functions...
	42	*/
	43
e1d6a774	44	static cupsd_quota_t add_quota(cupsd_printer_t p, const char *username);
	45	static int compare_quotas(const cupsd_quota_t *q1,
	46	const cupsd_quota_t *q2);
	47	static cupsd_quota_t find_quota(cupsd_printer_t p, const char *username);
ef416fc2	48
	49
	50	/*
	51	* 'cupsdFreeQuotas()' - Free quotas for a printer.
	52	*/
	53
	54	void
fa73b229	55	cupsdFreeQuotas(cupsd_printer_t p) / I - Printer */
ef416fc2	56	{
fa73b229	57	cupsd_quota_t q; / Current quota record */
	58
	59
ef416fc2	60	if (!p)
	61	return;
	62
fa73b229	63	for (q = (cupsd_quota_t *)cupsArrayFirst(p->quotas);
	64	q;
	65	q = (cupsd_quota_t *)cupsArrayNext(p->quotas))
	66	free(q);
	67
	68	cupsArrayDelete(p->quotas);
ef416fc2	69
fa73b229	70	p->quotas = NULL;
ef416fc2	71	}
	72
	73
	74	/*
	75	* 'cupsdUpdateQuota()' - Update quota data for the specified printer and user.
	76	*/
	77
	78	cupsd_quota_t * /* O - Quota data */
	79	cupsdUpdateQuota(
	80	cupsd_printer_t p, / I - Printer */
	81	const char username, / I - User */
	82	int pages, /* I - Number of pages */
	83	int k) /* I - Number of kilobytes */
	84	{
	85	cupsd_quota_t q; / Quota data */
	86	cupsd_job_t job; / Current job */
	87	time_t curtime; /* Current time */
	88	ipp_attribute_t attr; / Job attribute */
	89
	90
	91	if (!p \|\| !username)
	92	return (NULL);
	93
	94	if (!p->k_limit && !p->page_limit)
	95	return (NULL);
	96
e1d6a774	97	if ((q = find_quota(p, username)) == NULL)
ef416fc2	98	return (NULL);
	99
	100	cupsdLogMessage(CUPSD_LOG_DEBUG,
	101	"cupsdUpdateQuota: p=%s username=%s pages=%d k=%d",
	102	p->name, username, pages, k);
	103
7594b224	104	#if defined(__APPLE__) && defined(HAVE_DLFCN_H)
	105	/*
	106	* Use Apple PrintService quota enforcement if installed (X Server only)
	107	*/
	108
	109	if (AppleQuotas && PSQUpdateQuotaProc)
	110	{
	111	q->page_count = (*PSQUpdateQuotaProc)(p->name, p->info, username, pages, 0);
	112
	113	return (q);
	114	}
	115	#endif /* __APPLE__ && HAVE_DLFCN_H */
	116
ef416fc2	117	curtime = time(NULL);
	118
	119	if (curtime < q->next_update)
	120	{
	121	q->page_count += pages;
	122	q->k_count += k;
	123
	124	return (q);
	125	}
	126
	127	if (p->quota_period)
	128	curtime -= p->quota_period;
	129	else
	130	curtime = 0;
	131
	132	q->next_update = 0;
	133	q->page_count = 0;
	134	q->k_count = 0;
	135
	136	for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
	137	job;
	138	job = (cupsd_job_t *)cupsArrayNext(Jobs))
	139	{
	140	if (strcasecmp(job->dest, p->name) != 0 \|\|
	141	strcasecmp(job->username, q->username) != 0)
	142	continue;
	143
	144	if ((attr = ippFindAttribute(job->attrs, "time-at-completion",
	145	IPP_TAG_INTEGER)) == NULL)
	146	if ((attr = ippFindAttribute(job->attrs, "time-at-processing",
	147	IPP_TAG_INTEGER)) == NULL)
	148	attr = ippFindAttribute(job->attrs, "time-at-creation",
	149	IPP_TAG_INTEGER);
	150
	151	if (attr == NULL)
	152	break;
	153
	154	if (attr->values[0].integer < curtime)
	155	{
	156	if (JobAutoPurge)
07725fee	157	cupsdCancelJob(job, 1, IPP_JOB_CANCELED);
ef416fc2	158
	159	continue;
	160	}
	161
	162	if (q->next_update == 0)
	163	q->next_update = attr->values[0].integer + p->quota_period;
	164
	165	if ((attr = ippFindAttribute(job->attrs, "job-media-sheets-completed",
	166	IPP_TAG_INTEGER)) != NULL)
	167	q->page_count += attr->values[0].integer;
	168
	169	if ((attr = ippFindAttribute(job->attrs, "job-k-octets",
	170	IPP_TAG_INTEGER)) != NULL)
	171	q->k_count += attr->values[0].integer;
	172	}
	173
	174	return (q);
	175	}
	176
	177
e1d6a774	178	/*
	179	* 'add_quota()' - Add a quota record for this printer and user.
	180	*/
	181
07725fee	182	static cupsd_quota_t * /* O - Quota data */
e1d6a774	183	add_quota(cupsd_printer_t p, / I - Printer */
	184	const char username) / I - User */
	185	{
	186	cupsd_quota_t q; / New quota data */
	187
	188
	189	if (!p \|\| !username)
	190	return (NULL);
	191
	192	if (!p->quotas)
	193	p->quotas = cupsArrayNew((cups_array_func_t)compare_quotas, NULL);
	194
	195	if (!p->quotas)
	196	return (NULL);
	197
	198	if ((q = calloc(1, sizeof(cupsd_quota_t))) == NULL)
	199	return (NULL);
	200
	201	strlcpy(q->username, username, sizeof(q->username));
	202
	203	cupsArrayAdd(p->quotas, q);
	204
	205	return (q);
	206	}
	207
	208
ef416fc2	209	/*
fa73b229	210	* 'compare_quotas()' - Compare two quota records...
ef416fc2	211	*/
	212
	213	static int /* O - Result of comparison */
fa73b229	214	compare_quotas(const cupsd_quota_t q1, / I - First quota record */
fa73b229	215	const cupsd_quota_t q2) / I - Second quota record */
ef416fc2	216	{
	217	return (strcasecmp(q1->username, q2->username));
	218	}
	219
	220
	221	/*
e1d6a774	222	* 'find_quota()' - Find a quota record.
	223	*/
	224
07725fee	225	static cupsd_quota_t * /* O - Quota data */
e1d6a774	226	find_quota(cupsd_printer_t p, / I - Printer */
	227	const char username) / I - User */
	228	{
	229	cupsd_quota_t q, / Quota data pointer */
	230	match; /* Search data */
	231
	232
	233	if (!p \|\| !username)
	234	return (NULL);
	235
	236	strlcpy(match.username, username, sizeof(match.username));
	237
	238	if ((q = (cupsd_quota_t *)cupsArrayFind(p->quotas, &match)) != NULL)
	239	return (q);
	240	else
	241	return (add_quota(p, username));
	242	}
	243
	244
	245	/*
7594b224	246	* End of "$Id: quotas.c 6365 2007-03-19 20:56:57Z mike $".
ef416fc2	247	*/