Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PAPPL-based Printer Applications: Option setting presets via web interface #314

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

PAPPL-based Printer Applications: Option setting presets via web interface #314

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a53099c
Added : Preset Support in pappl
Ankit3002 Dec 12, 2023
710ea65
Remove unused code
Ankit3002 Dec 12, 2023
503765c
Remove unnecessary code
Ankit3002 Dec 12, 2023
9ad31c1
Merge branch 'michaelrsweet:master' into master
Ankit3002 Feb 19, 2024
3bff94e
Merge branch 'michaelrsweet:master' into master
Ankit3002 Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pappl/base.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@ typedef struct _pappl_subscription_s pappl_subscription_t;
// Subscription object
typedef struct _pappl_system_s pappl_system_t;
// System object
typedef struct pappl_pr_preset_data_s pappl_pr_preset_data_t;
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless needed outside printer.h, put it there...

// Preset data
typedef struct resource_data_s resource_data_t;
// Resource data

typedef struct pappl_contact_s // Contact information
{
Expand Down
228 changes: 228 additions & 0 deletions pappl/printer-driver.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,234 @@ papplPrinterGetDriverData(
return (data);
}

//
// 'papplPrinterAddPresetCreate' - Add a preset to the printer.
//
// This function adds the preset to the printer's preset array.
//

bool papplPrinterAddPresetCreate(pappl_printer_t *printer, pappl_pr_preset_data_t *preset)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, so naming is a bit confusing here. I suggest simply "papplPrinterAddPreset".

{
char path[256]; // Path to resource
pappl_system_t *system = papplPrinterGetSystem(printer);

_papplRWLockWrite(printer);

// Add preset to printer's array
if (!printer->presets)
printer->presets = cupsArrayNew(NULL, NULL, NULL, 0, NULL, NULL);
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably want the CUPS array to manage copying and freeing the preset data...

cupsArrayAdd(printer->presets, preset);

// Create resource data and set up routes
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not keen on presets creating resources; rather there should be a single resource for managing them with the preset name being passed as a query parameter and/or form data.

resource_data_t *resource_data = calloc(1, sizeof(resource_data_t));
resource_data->printer = printer;
resource_data->preset_name = preset->name;

// Edit route
snprintf(path, sizeof(path), "%s/presets/%s/edit", printer->uriname, preset->name);
papplSystemAddResourceCallback(system, path, "text/html", (pappl_resource_cb_t)_papplPrinterPresetEdit, resource_data);

// Copy route
snprintf(path, sizeof(path), "%s/presets/%s/copy", printer->uriname, preset->name);
papplSystemAddResourceCallback(system, path, "text/html", (pappl_resource_cb_t)_papplPrinterPresetCopy, resource_data);

// Delete route
snprintf(path, sizeof(path), "%s/presets/%s/delete", printer->uriname, preset->name);
papplSystemAddResourceCallback(system, path, "text/html", (pappl_resource_cb_t)_papplPrinterPresetDelete, resource_data);

printer->config_time = time(NULL);

_papplRWUnlock(printer);

_papplSystemConfigChanged(printer->system);
return (true);
}


//
// 'papplPrinterSetPresetsVendor()' - Set the vendor print option values in preset.
//
// This function validates and sets the printer's vendor print options into the preset.
//

bool // O - `true` on success or `false` on failure
papplPrinterSetPresetsVendor(
pappl_printer_t *printer, // I - Printer
pappl_pr_preset_data_t *data, // I - Driver data
int num_vendor, // I - Number of vendor options
cups_option_t *vendor) // I - Vendor options
{
int i; // Looping var
const char *value; // Vendor value
int intvalue; // Integer value
char *end, // End of value
defname[128], // xxx-default name
supname[128]; // xxx-supported name
ipp_attribute_t *supported; // xxx-supported attribute


if (!printer || !data)
return (false);


_papplRWLockWrite(printer);


// Copy any vendor-specific xxx-default values...
for (i = 0; i < printer->driver_data.num_vendor ; i++)
{
if ((value = cupsGetOption(printer->driver_data.vendor[i], (int)num_vendor, vendor)) == NULL)
continue;

snprintf(defname, sizeof(defname), "%s-default",printer->driver_data.vendor[i]);
snprintf(supname, sizeof(supname), "%s-supported", printer->driver_data.vendor[i]);

ippDeleteAttribute(data->driver_attrs, ippFindAttribute(data->driver_attrs, defname, IPP_TAG_ZERO));

// done till above ...

if ((supported = ippFindAttribute(printer->driver_attrs, supname, IPP_TAG_ZERO)) != NULL)
{
switch (ippGetValueTag(supported))
{
case IPP_TAG_INTEGER :
case IPP_TAG_RANGE :
intvalue = (int)strtol(value, &end, 10);
if (errno != ERANGE && !*end)
ippAddInteger(data->driver_attrs, IPP_TAG_PRINTER, IPP_TAG_INTEGER, defname, intvalue);
break;

case IPP_TAG_BOOLEAN :
ippAddBoolean(data->driver_attrs, IPP_TAG_PRINTER, defname, !strcmp(value, "true") || !strcmp(value, "on"));
break;

case IPP_TAG_KEYWORD :
ippAddString(data->driver_attrs, IPP_TAG_PRINTER, IPP_TAG_KEYWORD, defname, NULL, value);
break;

default :
papplLogPrinter(printer, PAPPL_LOGLEVEL_ERROR, "Driver '%s' attribute syntax not supported, only boolean, integer, keyword, and rangeOfInteger are supported.", supname);
break;
}
}
else
{
// Default to simple text values...
ippAddString(data->driver_attrs, IPP_TAG_PRINTER, IPP_TAG_TEXT, defname, NULL, value);
}
}

printer->config_time = time(NULL);

_papplRWUnlock(printer);

_papplSystemConfigChanged(printer->system);

return (true);
}

//
// 'papplPrinterSetPresetFromDriver()' - Set the vendor print option values in preset from Driver.
//
// This function validates and sets the printer's driver defaults into the preset.
//

bool // O - `true` on success or `false` on failure
papplPrinterSetPresetFromDriver(
pappl_printer_t * printer,
pappl_pr_driver_data_t *data, // I - Driver data
pappl_pr_preset_data_t *preset, // I - Printer
int num_vendor, // I - Number of vendor options
cups_option_t *vendor) // I - Vendor options
{
int i; // Looping var
const char *value; // Vendor value
int intvalue; // Integer value
char *end, // End of value
defname[128], // xxx-default name
supname[128]; // xxx-supported name
ipp_attribute_t *supported; // xxx-supported attribute


_papplRWLockWrite(printer);

// Copy xxx_default values...
preset->color_default = data->color_default;
preset->content_default = data->content_default;
preset->quality_default = data->quality_default;
preset->scaling_default = data->scaling_default;
preset->sides_default = data->sides_default;
preset->x_default = data->x_default;
preset->y_default = data->y_default;
preset->media_default = data->media_default;
preset->speed_default = data->speed_default;
preset->darkness_default = data->darkness_default;
preset->bin_default = data->bin_default;
preset->mode_configured = data->mode_configured;
preset->tear_offset_configured = data->tear_offset_configured;
preset->darkness_configured = data->darkness_configured;
preset->identify_default = data->identify_default;

// Copy any vendor-specific xxx-default values...
for (i = 0; i < data->num_vendor; i ++)
{
if ((value = cupsGetOption(data->vendor[i], (int)num_vendor, vendor)) == NULL)
continue;

snprintf(defname, sizeof(defname), "%s-default", data->vendor[i]);
snprintf(supname, sizeof(supname), "%s-supported", data->vendor[i]);

ippDeleteAttribute(preset->driver_attrs, ippFindAttribute(preset->driver_attrs, defname, IPP_TAG_ZERO));



if ((supported = ippFindAttribute(printer->driver_attrs, supname, IPP_TAG_ZERO)) != NULL)
{
switch (ippGetValueTag(supported))
{
case IPP_TAG_INTEGER :
case IPP_TAG_RANGE :
intvalue = (int)strtol(value, &end, 10);
if (errno != ERANGE && !*end)
{

ippAddInteger(preset->driver_attrs, IPP_TAG_PRINTER, IPP_TAG_INTEGER, defname, intvalue);

// cheking whether the attribute gets added in the preset structure...


break;
}


case IPP_TAG_BOOLEAN :
ippAddBoolean(preset->driver_attrs, IPP_TAG_PRINTER, defname, !strcmp(value, "true") || !strcmp(value, "on"));
break;

case IPP_TAG_KEYWORD :
ippAddString(preset->driver_attrs, IPP_TAG_PRINTER, IPP_TAG_KEYWORD, defname, NULL, value);
break;

default :
// papplLogPrinter(printer, PAPPL_LOGLEVEL_ERROR, "Driver '%s' attribute syntax not supported, only boolean, integer, keyword, and rangeOfInteger are supported.", supname);
break;
}
}
else
{
// Default to simple text values...
ippAddString(preset->driver_attrs, IPP_TAG_PRINTER, IPP_TAG_TEXT, defname, NULL, value);
}
}

printer->config_time = time(NULL);

_papplRWUnlock(printer);

_papplSystemConfigChanged(printer->system);

return (true);
}

//
// 'papplPrinterGetDriverName()' - Get the driver name for a printer.
Expand Down
9 changes: 8 additions & 1 deletion pappl/printer-private.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ struct _pappl_printer_s // Printer data
char *usb_storage; // USB storage gadget file, if any
pappl_pr_usb_cb_t usb_cb; // USB processing callback, if any
void *usb_cbdata; // USB processing callback data, if any
cups_array_t *presets; // Array of presets...
};


Expand Down Expand Up @@ -166,6 +167,12 @@ extern const char *_papplSupplyColorString(pappl_supply_color_t value) _PAPPL_PR
extern pappl_supply_color_t _papplSupplyColorValue(const char *value) _PAPPL_PRIVATE;
extern const char *_papplSupplyTypeString(pappl_supply_type_t value) _PAPPL_PRIVATE;
extern pappl_supply_type_t _papplSupplyTypeValue(const char *value) _PAPPL_PRIVATE;

extern void _papplPrinterPreset(pappl_client_t *client, pappl_printer_t *printer) _PAPPL_PRIVATE;
extern void _papplPrinterPresetEdit(pappl_client_t *client, resource_data_t * resource_data) _PAPPL_PRIVATE;
extern void _papplPrinterPresetCreate(pappl_client_t *client, pappl_printer_t *printer) _PAPPL_PRIVATE;
extern void _papplPrinterPresetCopy(pappl_client_t *client, resource_data_t *resource_data) _PAPPL_PRIVATE;
extern void _papplPrinterInitPresetData(pappl_pr_preset_data_t *d) _PAPPL_PRIVATE;
extern void _papplPrinterPresetDelete(pappl_client_t *client, resource_data_t *resource_data) _PAPPL_PRIVATE;
extern void _papplPresetDelete( pappl_pr_preset_data_t * preset , pappl_printer_t * printer ) _PAPPL_PRIVATE;

#endif // !_PAPPL_PRINTER_PRIVATE_H_
Loading