Blame channels/printer/client/cups/printer_cups.c

Packit Service 5a9772
/**
Packit Service 5a9772
 * FreeRDP: A Remote Desktop Protocol Implementation
Packit Service 5a9772
 * Print Virtual Channel - CUPS driver
Packit Service 5a9772
 *
Packit Service 5a9772
 * Copyright 2010-2011 Vic Lee
Packit Service 5a9772
 * Copyright 2015 Thincast Technologies GmbH
Packit Service 5a9772
 * Copyright 2015 DI (FH) Martin Haimberger <martin.haimberger@thincast.com>
Packit Service 5a9772
 * Copyright 2016 Armin Novak <armin.novak@gmail.com>
Packit Service 5a9772
 *
Packit Service 5a9772
 * Licensed under the Apache License, Version 2.0 (the "License");
Packit Service 5a9772
 * you may not use this file except in compliance with the License.
Packit Service 5a9772
 * You may obtain a copy of the License at
Packit Service 5a9772
 *
Packit Service 5a9772
 *     http://www.apache.org/licenses/LICENSE-2.0
Packit Service 5a9772
 *
Packit Service 5a9772
 * Unless required by applicable law or agreed to in writing, software
Packit Service 5a9772
 * distributed under the License is distributed on an "AS IS" BASIS,
Packit Service 5a9772
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Packit Service 5a9772
 * See the License for the specific language governing permissions and
Packit Service 5a9772
 * limitations under the License.
Packit Service 5a9772
 */
Packit Service 5a9772
Packit Service 5a9772
#ifdef HAVE_CONFIG_H
Packit Service 5a9772
#include "config.h"
Packit Service 5a9772
#endif
Packit Service 5a9772
Packit Service 5a9772
#include <stdio.h>
Packit Service 5a9772
#include <stdlib.h>
Packit Service 5a9772
#include <string.h>
Packit Service 5a9772
#include <pthread.h>
Packit Service 5a9772
Packit Service 5a9772
#include <time.h>
Packit Service 5a9772
#include <cups/cups.h>
Packit Service 5a9772
Packit Service 5a9772
#include <winpr/crt.h>
Packit Service 5a9772
#include <winpr/string.h>
Packit Service 5a9772
Packit Service 5a9772
#include <freerdp/channels/rdpdr.h>
Packit Service 5a9772
Packit Service 5a9772
#include <freerdp/client/printer.h>
Packit Service 5a9772
Packit Service 5a9772
typedef struct rdp_cups_printer_driver rdpCupsPrinterDriver;
Packit Service 5a9772
typedef struct rdp_cups_printer rdpCupsPrinter;
Packit Service 5a9772
typedef struct rdp_cups_print_job rdpCupsPrintJob;
Packit Service 5a9772
Packit Service 5a9772
struct rdp_cups_printer_driver
Packit Service 5a9772
{
Packit Service 5a9772
	rdpPrinterDriver driver;
Packit Service 5a9772
Packit Service 5a9772
	int id_sequence;
Packit Service 5a9772
	size_t references;
Packit Service 5a9772
};
Packit Service 5a9772
Packit Service 5a9772
struct rdp_cups_printer
Packit Service 5a9772
{
Packit Service 5a9772
	rdpPrinter printer;
Packit Service 5a9772
Packit Service 5a9772
	rdpCupsPrintJob* printjob;
Packit Service 5a9772
};
Packit Service 5a9772
Packit Service 5a9772
struct rdp_cups_print_job
Packit Service 5a9772
{
Packit Service 5a9772
	rdpPrintJob printjob;
Packit Service 5a9772
Packit Service 5a9772
	void* printjob_object;
Packit Service 5a9772
	int printjob_id;
Packit Service 5a9772
};
Packit Service 5a9772
Packit Service 5a9772
static void printer_cups_get_printjob_name(char* buf, size_t size, size_t id)
Packit Service 5a9772
{
Packit Service 5a9772
	time_t tt;
Packit Service 5a9772
	struct tm* t;
Packit Service 5a9772
Packit Service 5a9772
	tt = time(NULL);
Packit Service 5a9772
	t = localtime(&tt;;
Packit Service 5a9772
	sprintf_s(buf, size - 1, "FreeRDP Print %04d-%02d-%02d %02d-%02d-%02d - Job %" PRIdz,
Packit Service 5a9772
	          t->tm_year + 1900, t->tm_mon + 1, t->tm_mday, t->tm_hour, t->tm_min, t->tm_sec, id);
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
/**
Packit Service 5a9772
 * Function description
Packit Service 5a9772
 *
Packit Service 5a9772
 * @return 0 on success, otherwise a Win32 error code
Packit Service 5a9772
 */
Packit Service 5a9772
static UINT printer_cups_write_printjob(rdpPrintJob* printjob, const BYTE* data, size_t size)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpCupsPrintJob* cups_printjob = (rdpCupsPrintJob*)printjob;
Packit Service 5a9772
Packit Service 5a9772
#ifndef _CUPS_API_1_4
Packit Service 5a9772
Packit Service 5a9772
	{
Packit Service 5a9772
		FILE* fp;
Packit Service 5a9772
Packit Service 5a9772
		fp = fopen((const char*)cups_printjob->printjob_object, "a+b");
Packit Service 5a9772
Packit Service 5a9772
		if (!fp)
Packit Service 5a9772
			return ERROR_INTERNAL_ERROR;
Packit Service 5a9772
Packit Service 5a9772
		if (fwrite(data, 1, size, fp) < size)
Packit Service 5a9772
		{
Packit Service 5a9772
			fclose(fp);
Packit Service 5a9772
			return ERROR_INTERNAL_ERROR;
Packit Service 5a9772
			// FIXME once this function doesn't return void anymore!
Packit Service 5a9772
		}
Packit Service 5a9772
Packit Service 5a9772
		fclose(fp);
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
#else
Packit Service 5a9772
Packit Service 5a9772
	cupsWriteRequestData((http_t*)cups_printjob->printjob_object, (const char*)data, size);
Packit Service 5a9772
Packit Service 5a9772
#endif
Packit Service 5a9772
Packit Service 5a9772
	return CHANNEL_RC_OK;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static void printer_cups_close_printjob(rdpPrintJob* printjob)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpCupsPrintJob* cups_printjob = (rdpCupsPrintJob*)printjob;
Packit Service 5a9772
Packit Service 5a9772
#ifndef _CUPS_API_1_4
Packit Service 5a9772
Packit Service 5a9772
	{
Packit Service 5a9772
		char buf[100];
Packit Service 5a9772
Packit Service 5a9772
		printer_cups_get_printjob_name(buf, sizeof(buf), printjob->id);
Packit Service 5a9772
Packit Service 5a9772
		if (cupsPrintFile(printjob->printer->name, (const char*)cups_printjob->printjob_object, buf,
Packit Service 5a9772
		                  0, NULL) == 0)
Packit Service 5a9772
		{
Packit Service 5a9772
		}
Packit Service 5a9772
Packit Service 5a9772
		unlink(cups_printjob->printjob_object);
Packit Service 5a9772
		free(cups_printjob->printjob_object);
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
#else
Packit Service 5a9772
Packit Service 5a9772
	cupsFinishDocument((http_t*)cups_printjob->printjob_object, printjob->printer->name);
Packit Service 5a9772
	cups_printjob->printjob_id = 0;
Packit Service 5a9772
	httpClose((http_t*)cups_printjob->printjob_object);
Packit Service 5a9772
Packit Service 5a9772
#endif
Packit Service 5a9772
Packit Service 5a9772
	((rdpCupsPrinter*)printjob->printer)->printjob = NULL;
Packit Service 5a9772
	free(cups_printjob);
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static rdpPrintJob* printer_cups_create_printjob(rdpPrinter* printer, UINT32 id)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpCupsPrinter* cups_printer = (rdpCupsPrinter*)printer;
Packit Service 5a9772
	rdpCupsPrintJob* cups_printjob;
Packit Service 5a9772
Packit Service 5a9772
	if (cups_printer->printjob != NULL)
Packit Service 5a9772
		return NULL;
Packit Service 5a9772
Packit Service 5a9772
	cups_printjob = (rdpCupsPrintJob*)calloc(1, sizeof(rdpCupsPrintJob));
Packit Service 5a9772
	if (!cups_printjob)
Packit Service 5a9772
		return NULL;
Packit Service 5a9772
Packit Service 5a9772
	cups_printjob->printjob.id = id;
Packit Service 5a9772
	cups_printjob->printjob.printer = printer;
Packit Service 5a9772
Packit Service 5a9772
	cups_printjob->printjob.Write = printer_cups_write_printjob;
Packit Service 5a9772
	cups_printjob->printjob.Close = printer_cups_close_printjob;
Packit Service 5a9772
Packit Service 5a9772
#ifndef _CUPS_API_1_4
Packit Service 5a9772
Packit Service 5a9772
	cups_printjob->printjob_object = _strdup(tmpnam(NULL));
Packit Service 5a9772
	if (!cups_printjob->printjob_object)
Packit Service 5a9772
	{
Packit Service 5a9772
		free(cups_printjob);
Packit Service 5a9772
		return NULL;
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
#else
Packit Service 5a9772
	{
Packit Service 5a9772
		char buf[100];
Packit Service 5a9772
Packit Service 5a9772
#if !defined(_CUPS_API_1_7)
Packit Service 5a9772
		cups_printjob->printjob_object =
Packit Service 5a9772
		    httpConnectEncrypt(cupsServer(), ippPort(), HTTP_ENCRYPT_IF_REQUESTED);
Packit Service 5a9772
#else
Packit Service 5a9772
		cups_printjob->printjob_object = httpConnect2(cupsServer(), ippPort(), NULL, AF_UNSPEC,
Packit Service 5a9772
		                                              HTTP_ENCRYPT_IF_REQUESTED, 1, 10000, NULL);
Packit Service 5a9772
#endif
Packit Service 5a9772
		if (!cups_printjob->printjob_object)
Packit Service 5a9772
		{
Packit Service 5a9772
			free(cups_printjob);
Packit Service 5a9772
			return NULL;
Packit Service 5a9772
		}
Packit Service 5a9772
Packit Service 5a9772
		printer_cups_get_printjob_name(buf, sizeof(buf), cups_printjob->printjob.id);
Packit Service 5a9772
Packit Service 5a9772
		cups_printjob->printjob_id =
Packit Service 5a9772
		    cupsCreateJob((http_t*)cups_printjob->printjob_object, printer->name, buf, 0, NULL);
Packit Service 5a9772
Packit Service 5a9772
		if (!cups_printjob->printjob_id)
Packit Service 5a9772
		{
Packit Service 5a9772
			httpClose((http_t*)cups_printjob->printjob_object);
Packit Service 5a9772
			free(cups_printjob);
Packit Service 5a9772
			return NULL;
Packit Service 5a9772
		}
Packit Service 5a9772
Packit Service 5a9772
		cupsStartDocument((http_t*)cups_printjob->printjob_object, printer->name,
Packit Service 5a9772
		                  cups_printjob->printjob_id, buf, CUPS_FORMAT_AUTO, 1);
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
#endif
Packit Service 5a9772
Packit Service 5a9772
	cups_printer->printjob = cups_printjob;
Packit Service 5a9772
Packit Service 5a9772
	return (rdpPrintJob*)cups_printjob;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static rdpPrintJob* printer_cups_find_printjob(rdpPrinter* printer, UINT32 id)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpCupsPrinter* cups_printer = (rdpCupsPrinter*)printer;
Packit Service 5a9772
Packit Service 5a9772
	if (cups_printer->printjob == NULL)
Packit Service 5a9772
		return NULL;
Packit Service 5a9772
	if (cups_printer->printjob->printjob.id != id)
Packit Service 5a9772
		return NULL;
Packit Service 5a9772
Packit Service 5a9772
	return (rdpPrintJob*)cups_printer->printjob;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static void printer_cups_free_printer(rdpPrinter* printer)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpCupsPrinter* cups_printer = (rdpCupsPrinter*)printer;
Packit Service 5a9772
Packit Service 5a9772
	if (cups_printer->printjob)
Packit Service 5a9772
		cups_printer->printjob->printjob.Close((rdpPrintJob*)cups_printer->printjob);
Packit Service 5a9772
Packit Service 5a9772
	if (printer->backend)
Packit Service 5a9772
		printer->backend->ReleaseRef(printer->backend);
Packit Service 5a9772
	free(printer->name);
Packit Service 5a9772
	free(printer->driver);
Packit Service 5a9772
	free(printer);
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static void printer_cups_add_ref_printer(rdpPrinter* printer)
Packit Service 5a9772
{
Packit Service 5a9772
	if (printer)
Packit Service 5a9772
		printer->references++;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static void printer_cups_release_ref_printer(rdpPrinter* printer)
Packit Service 5a9772
{
Packit Service 5a9772
	if (!printer)
Packit Service 5a9772
		return;
Packit Service 5a9772
	if (printer->references <= 1)
Packit Service 5a9772
		printer_cups_free_printer(printer);
Packit Service 5a9772
	else
Packit Service 5a9772
		printer->references--;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static rdpPrinter* printer_cups_new_printer(rdpCupsPrinterDriver* cups_driver, const char* name,
Packit Service 5a9772
                                            const char* driverName, BOOL is_default)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpCupsPrinter* cups_printer;
Packit Service 5a9772
Packit Service 5a9772
	cups_printer = (rdpCupsPrinter*)calloc(1, sizeof(rdpCupsPrinter));
Packit Service 5a9772
	if (!cups_printer)
Packit Service 5a9772
		return NULL;
Packit Service 5a9772
Packit Service 5a9772
	cups_printer->printer.backend = &cups_driver->driver;
Packit Service 5a9772
Packit Service 5a9772
	cups_printer->printer.id = cups_driver->id_sequence++;
Packit Service 5a9772
	cups_printer->printer.name = _strdup(name);
Packit Service 5a9772
	if (!cups_printer->printer.name)
Packit Service 5a9772
	{
Packit Service 5a9772
		free(cups_printer);
Packit Service 5a9772
		return NULL;
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	if (driverName)
Packit Service 5a9772
		cups_printer->printer.driver = _strdup(driverName);
Packit Service 5a9772
	else
Packit Service 5a9772
		cups_printer->printer.driver = _strdup("MS Publisher Imagesetter");
Packit Service 5a9772
	if (!cups_printer->printer.driver)
Packit Service 5a9772
	{
Packit Service 5a9772
		free(cups_printer->printer.name);
Packit Service 5a9772
		free(cups_printer);
Packit Service 5a9772
		return NULL;
Packit Service 5a9772
	}
Packit Service 5a9772
	cups_printer->printer.is_default = is_default;
Packit Service 5a9772
Packit Service 5a9772
	cups_printer->printer.CreatePrintJob = printer_cups_create_printjob;
Packit Service 5a9772
	cups_printer->printer.FindPrintJob = printer_cups_find_printjob;
Packit Service 5a9772
	cups_printer->printer.AddRef = printer_cups_add_ref_printer;
Packit Service 5a9772
	cups_printer->printer.ReleaseRef = printer_cups_release_ref_printer;
Packit Service 5a9772
Packit Service 5a9772
	cups_printer->printer.AddRef(&cups_printer->printer);
Packit Service 5a9772
	cups_printer->printer.backend->AddRef(cups_printer->printer.backend);
Packit Service 5a9772
	return &cups_printer->printer;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static void printer_cups_release_enum_printers(rdpPrinter** printers)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpPrinter** cur = printers;
Packit Service 5a9772
Packit Service 5a9772
	while ((cur != NULL) && ((*cur) != NULL))
Packit Service 5a9772
	{
Packit Service 5a9772
		if ((*cur)->ReleaseRef)
Packit Service 5a9772
			(*cur)->ReleaseRef(*cur);
Packit Service 5a9772
		cur++;
Packit Service 5a9772
	}
Packit Service 5a9772
	free(printers);
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static rdpPrinter** printer_cups_enum_printers(rdpPrinterDriver* driver)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpPrinter** printers;
Packit Service 5a9772
	int num_printers;
Packit Service 5a9772
	cups_dest_t* dests;
Packit Service 5a9772
	cups_dest_t* dest;
Packit Service 5a9772
	int num_dests;
Packit Service 5a9772
	int i;
Packit Service 5a9772
Packit Service 5a9772
	num_dests = cupsGetDests(&dests);
Packit Service 5a9772
	printers = (rdpPrinter**)calloc(num_dests + 1, sizeof(rdpPrinter*));
Packit Service 5a9772
	if (!printers)
Packit Service 5a9772
		return NULL;
Packit Service 5a9772
Packit Service 5a9772
	num_printers = 0;
Packit Service 5a9772
Packit Service 5a9772
	for (i = 0, dest = dests; i < num_dests; i++, dest++)
Packit Service 5a9772
	{
Packit Service 5a9772
		if (dest->instance == NULL)
Packit Service 5a9772
		{
Packit Service 5a9772
			rdpPrinter* current = printer_cups_new_printer((rdpCupsPrinterDriver*)driver,
Packit Service 5a9772
			                                               dest->name, NULL, dest->is_default);
Packit Service 5a9772
			if (!current)
Packit Service 5a9772
			{
Packit Service 5a9772
				printer_cups_release_enum_printers(printers);
Packit Service 5a9772
				printers = NULL;
Packit Service 5a9772
				break;
Packit Service 5a9772
			}
Packit Service 5a9772
Packit Service 5a9772
			printers[num_printers++] = current;
Packit Service 5a9772
		}
Packit Service 5a9772
	}
Packit Service 5a9772
	cupsFreeDests(num_dests, dests);
Packit Service 5a9772
Packit Service 5a9772
	return printers;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static rdpPrinter* printer_cups_get_printer(rdpPrinterDriver* driver, const char* name,
Packit Service 5a9772
                                            const char* driverName)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpCupsPrinterDriver* cups_driver = (rdpCupsPrinterDriver*)driver;
Packit Service 5a9772
Packit Service 5a9772
	return printer_cups_new_printer(cups_driver, name, driverName,
Packit Service 5a9772
	                                cups_driver->id_sequence == 1 ? TRUE : FALSE);
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
static void printer_cups_add_ref_driver(rdpPrinterDriver* driver)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpCupsPrinterDriver* cups_driver = (rdpCupsPrinterDriver*)driver;
Packit Service 5a9772
	if (cups_driver)
Packit Service 5a9772
		cups_driver->references++;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
/* Singleton */
Packit Service 5a9772
static rdpCupsPrinterDriver* uniq_cups_driver = NULL;
Packit Service 5a9772
Packit Service 5a9772
static void printer_cups_release_ref_driver(rdpPrinterDriver* driver)
Packit Service 5a9772
{
Packit Service 5a9772
	rdpCupsPrinterDriver* cups_driver = (rdpCupsPrinterDriver*)driver;
Packit Service 5a9772
	if (cups_driver->references <= 1)
Packit Service 5a9772
	{
Packit Service 5a9772
		if (uniq_cups_driver == cups_driver)
Packit Service 5a9772
			uniq_cups_driver = NULL;
Packit Service 5a9772
		free(cups_driver);
Packit Service 5a9772
		cups_driver = NULL;
Packit Service 5a9772
	}
Packit Service 5a9772
	else
Packit Service 5a9772
		cups_driver->references--;
Packit Service 5a9772
}
Packit Service 5a9772
Packit Service 5a9772
#ifdef BUILTIN_CHANNELS
Packit Service 5a9772
rdpPrinterDriver* cups_freerdp_printer_client_subsystem_entry(void)
Packit Service 5a9772
#else
Packit Service 5a9772
FREERDP_API rdpPrinterDriver* freerdp_printer_client_subsystem_entry(void)
Packit Service 5a9772
#endif
Packit Service 5a9772
{
Packit Service 5a9772
	if (!uniq_cups_driver)
Packit Service 5a9772
	{
Packit Service 5a9772
		uniq_cups_driver = (rdpCupsPrinterDriver*)calloc(1, sizeof(rdpCupsPrinterDriver));
Packit Service 5a9772
Packit Service 5a9772
		if (!uniq_cups_driver)
Packit Service 5a9772
			return NULL;
Packit Service 5a9772
Packit Service 5a9772
		uniq_cups_driver->driver.EnumPrinters = printer_cups_enum_printers;
Packit Service 5a9772
		uniq_cups_driver->driver.ReleaseEnumPrinters = printer_cups_release_enum_printers;
Packit Service 5a9772
		uniq_cups_driver->driver.GetPrinter = printer_cups_get_printer;
Packit Service 5a9772
Packit Service 5a9772
		uniq_cups_driver->driver.AddRef = printer_cups_add_ref_driver;
Packit Service 5a9772
		uniq_cups_driver->driver.ReleaseRef = printer_cups_release_ref_driver;
Packit Service 5a9772
Packit Service 5a9772
		uniq_cups_driver->id_sequence = 1;
Packit Service 5a9772
		uniq_cups_driver->driver.AddRef(&uniq_cups_driver->driver);
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	return &uniq_cups_driver->driver;
Packit Service 5a9772
}