gecko-dev/widget/nsCUPSShim.h
Emily McDonough c286431b9a Bug 1691347 - Work around a null argument bug in _platform_strstr in CUPS. r=dholbert
This is just a large conditional to check for the specific branches taken
that would result in the null string. The path in CUPS is as follows:

In cupsCopyDestInfo, CUPS_DEST_FLAG_DEVICE is set when the connection is not
null (same as CUPS_HTTP_DEFAULT), the print server is not the same as our
hostname and is not path-based (starts with a '/'), or the IPP port is
different than the global server IPP port.

c9da6f63b2/cups/dest-options.c (L718-L722)

In _cupsGetDestResource, CUPS fetches the IPP options "printer-uri-supported"
and "device-uri". Importantly, IPP options are returned as null when missing.

23c45db76a/cups/dest.c (L1138-L1141)

If the CUPS_DEST_FLAG_DEVICE is set or the "printer-uri-supported" option is
not set, CUPS checks for "._tcp" in the "device-uri" option without doing a
NULL-check first.

23c45db76a/cups/dest.c (L1144)

If we find that those branches will be taken, don't actually fetch the CUPS
data and instead just return an empty printer info.

Differential Revision: https://phabricator.services.mozilla.com/D128529
2021-10-22 22:55:25 +00:00

96 lines
3.2 KiB
C++

/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ex: set tabstop=8 softtabstop=2 shiftwidth=2 expandtab: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsCUPSShim_h___
#define nsCUPSShim_h___
#include <cups/cups.h>
#include "mozilla/Atomics.h"
#include "mozilla/Mutex.h"
// TODO: This should be a configure option, ideally.
#ifndef XP_MACOSX
# define CUPS_SHIM_RUNTIME_LINK
#endif
struct PRLibrary;
class nsCUPSShim {
public:
#ifdef CUPS_SHIM_RUNTIME_LINK
nsCUPSShim();
bool InitOkay() { return mInitOkay; }
#else
nsCUPSShim() = default;
bool InitOkay() { return true; }
#endif
// We allow some functions to be missing, to degrade as gracefully as possible
// for older versions of CUPS.
//
// The current target is CUPS 1.6 (bug 1701019).
enum class Optional : bool { No, Yes };
/**
* Function pointers for supported functions. These are only
* valid after successful initialization.
*/
#define CUPS_SHIM_ALL_FUNCS(X) \
X(Optional::No, cupsAddOption) \
X(Optional::No, cupsCheckDestSupported) \
X(Optional::No, cupsConnectDest) \
X(Optional::No, cupsCopyDest) \
X(Optional::No, cupsCopyDestInfo) \
X(Optional::No, cupsDoRequest) \
X(Optional::No, cupsEnumDests) \
X(Optional::No, cupsFreeDestInfo) \
X(Optional::No, cupsFreeDests) \
X(Optional::No, cupsGetDestMediaByName) \
X(Optional::Yes, cupsFindDestDefault) \
X(Optional::Yes, cupsGetDestMediaDefault) \
X(Optional::Yes, cupsGetDestMediaCount) \
X(Optional::Yes, cupsGetDestMediaByIndex) \
X(Optional::Yes, cupsLocalizeDestMedia) \
X(Optional::No, cupsGetDest) \
X(Optional::No, cupsGetDests) \
X(Optional::No, cupsGetNamedDest) \
X(Optional::No, cupsGetOption) \
X(Optional::No, cupsServer) \
X(Optional::Yes, httpAddrPort) \
X(Optional::No, httpClose) \
X(Optional::No, httpGetHostname) \
X(Optional::Yes, httpGetAddress) \
X(Optional::No, ippAddString) \
X(Optional::No, ippAddStrings) \
X(Optional::No, ippDelete) \
X(Optional::No, ippFindAttribute) \
X(Optional::No, ippGetCount) \
X(Optional::No, ippGetString) \
X(Optional::No, ippNewRequest) \
X(Optional::No, ippPort)
#ifdef CUPS_SHIM_RUNTIME_LINK
// Define a single field which holds a function pointer.
# define CUPS_SHIM_FUNC_DECL(opt_, fn_) decltype(::fn_)* fn_ = nullptr;
#else
// Define a static constexpr function pointer. GCC can sometimes optimize
// away the pointer fetch for this.
# define CUPS_SHIM_FUNC_DECL(opt_, fn_) \
static constexpr decltype(::fn_)* const fn_ = ::fn_;
#endif
CUPS_SHIM_ALL_FUNCS(CUPS_SHIM_FUNC_DECL)
#undef CUPS_SHIM_FUNC_DECL
#ifdef CUPS_SHIM_RUNTIME_LINK
private:
bool mInitOkay = false;
PRLibrary* mCupsLib = nullptr;
#endif
};
#endif /* nsCUPSShim_h___ */