print_service/src/print_cups_attribute.cpp

/*
 * Copyright (c) 2023 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <vector>
#include <string>

#include "print_cups_attribute.h"
#include "print_service_converter.h"
#include "print_log.h"

namespace OHOS::Print {
template <typename T>
bool ParseAttributeToValue(ipp_t *response, const std::string &keyword, T &value,
    bool (*convertAttr)(const char *src, T &dst))
{
    if (convertAttr == nullptr) {
        PRINT_HILOGW("convertAttr is null");
        return false;
    }
    ipp_attribute_t *attrPtr = ippFindAttribute(response, keyword.c_str(), IPP_TAG_KEYWORD);
    if (attrPtr == nullptr) {
        PRINT_HILOGW("attrPtr is null");
        return false;
    }
    const char *attrString = ippGetString(attrPtr, 0, NULL);
    if (attrString == nullptr) {
        PRINT_HILOGW("attrString is null");
        return false;
    }
    PRINT_HILOGD("attrString: %{public}s", attrString);
    if (!convertAttr(attrString, value)) {
        PRINT_HILOGW("ConvertFunction fail");
        return false;
    }
    return true;
}

template <typename T>
bool ParseAttributesToList(ipp_t *response, const std::string &keyword, std::vector<T> &list,
    bool (*convertAttr)(const char *src, T &dst))
{
    if (convertAttr == nullptr) {
        PRINT_HILOGW("convertAttr is null");
        return false;
    }
    ipp_attribute_t *attrPtr = ippFindAttribute(response, keyword.c_str(), IPP_TAG_KEYWORD);
    if (attrPtr == nullptr) {
        PRINT_HILOGW("attrPtr is null");
        return false;
    }
    int num = ippGetCount(attrPtr);
    PRINT_HILOGD("number of values %{public}d", num);
    for (int i = 0; i < num; i++) {
        const char *attrString = ippGetString(attrPtr, i, NULL);
        if (attrString == nullptr) {
            PRINT_HILOGW("attrString is null");
            continue;
        }
        PRINT_HILOGD("attrString: %{public}s", attrString);
        T attrValue;
        if (!convertAttr(attrString, attrValue)) {
            PRINT_HILOGW("ConvertFunction fail");
            continue;
        }
        AddToUniqueList<T>(list, attrValue);
    }
    return true;
}

bool ConvertDuplexModeCode(const char *src, DuplexModeCode &dst)
{
    if (src == nullptr) {
        return false;
    }
    if (strcasestr(src, CUPS_SIDES_ONE_SIDED)) {
        dst = DUPLEX_MODE_ONE_SIDED;
    } else if (strcasestr(src, CUPS_SIDES_TWO_SIDED_PORTRAIT)) {
        dst = DUPLEX_MODE_TWO_SIDED_LONG_EDGE;
    } else if (strcasestr(src, CUPS_SIDES_TWO_SIDED_LANDSCAPE)) {
        dst = DUPLEX_MODE_TWO_SIDED_SHORT_EDGE;
    } else {
        return false;
    }
    return true;
}

std::string ConvertIppAttributesToJsonString(ipp_t *response, const std::string &keyword, ipp_tag_t tag)
{
    ipp_attribute_t *attrPtr = ippFindAttribute(response, keyword.c_str(), tag);
    if (attrPtr == nullptr) {
        return "";
    }
    nlohmann::json jsonArray = nlohmann::json::array();
    for (int i = 0; i < ippGetCount(attrPtr); i++) {
        const char *attrString = ippGetString(attrPtr, i, NULL);
        if (attrString == nullptr) {
            continue;
        }
        jsonArray.push_back(attrString);
    }
    return jsonArray.dump();
}

void SetCapabilityGroupAttribute(ipp_t *response, PrinterCapability &printerCaps)
{
    ipp_attribute_t *attrPtr;
    if ((attrPtr = ippFindAttribute(response, "printer-state", IPP_TAG_ENUM)) != NULL) {
        printerCaps.SetPrinterAttrNameAndValue("printer-state",
            ippEnumString("printer-state", ippGetInteger(attrPtr, 0)));
    }
    if ((attrPtr = ippFindAttribute(response, "printer-info", IPP_TAG_TEXTLANG)) != NULL) {
        printerCaps.SetPrinterAttrNameAndValue("printer-info", ippGetString(attrPtr, 0, NULL));
    }
    if ((attrPtr = ippFindAttribute(response, "printer-location", IPP_TAG_TEXT)) != NULL) {
        printerCaps.SetPrinterAttrNameAndValue("printer-location", ippGetString(attrPtr, 0, NULL));
    }
}

void ParseDuplexModeAttributes(ipp_t *response, PrinterCapability &printerCaps)
{
    std::string keyword = "sides-supported";
    std::vector<DuplexModeCode> list;
    ParseAttributesToList(response, keyword, list, ConvertDuplexModeCode);
    std::string duplexModeJson = ConvertListToJson<DuplexModeCode>(list, ConvertDuplexModeToJson);
    printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), duplexModeJson.c_str());
    size_t num = list.size();
    if (static_cast<int>(num) <= 1) {
        printerCaps.SetDuplexMode((uint32_t)DUPLEX_MODE_ONE_SIDED);
    } else {
        printerCaps.SetDuplexMode((uint32_t)DUPLEX_MODE_TWO_SIDED_LONG_EDGE);
    }

    keyword = "sides-default";
    DuplexModeCode code;
    if (ParseAttributeToValue<DuplexModeCode>(response, keyword, code, ConvertDuplexModeCode)) {
        uint32_t value = static_cast<uint32_t>(code);
        printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), std::to_string(value).c_str());
    }
}

void ParseColorModeAttributes(ipp_t *response, PrinterCapability &printerCaps)
{
    std::string keyword = "print-color-mode-supported";
    std::vector<ColorModeCode> supportedColorModes;
    ParseAttributesToList<ColorModeCode>(response, keyword, supportedColorModes, ConvertColorModeCode);
    std::string colorModeJson = ConvertListToJson<ColorModeCode>(supportedColorModes, ConvertColorModeToJson);
    printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), colorModeJson.c_str());

    keyword = "print-color-mode-default";
    ColorModeCode code;
    if (ParseAttributeToValue<ColorModeCode>(response, keyword, code, ConvertColorModeCode)) {
        uint32_t mode = static_cast<uint32_t>(code);
        printerCaps.SetPrinterAttrNameAndValue("defaultColorMode", std::to_string(mode).c_str());
    }
    for (auto& color : supportedColorModes) {
        if (color == ColorModeCode::COLOR_MODE_COLOR) {
            printerCaps.SetColorMode(ColorModeCode::COLOR_MODE_COLOR);
            break;
        }
    }
}

void ParsePageSizeAttributes(ipp_t *response, PrinterCapability &printerCaps)
{
    std::string keyword = "media-supported";
    std::vector<PrintPageSize> supportedPageSizes;
    ParseAttributesToList<PrintPageSize>(response, keyword, supportedPageSizes, ConvertPrintPageSize);
    std::string pageSizeJson = ConvertListToJson<PrintPageSize>(supportedPageSizes, ConvertPageSizeToJson);
    printerCaps.SetPageSize(supportedPageSizes);
    printerCaps.SetPrinterAttrNameAndValue("supportedPageSizeArray", pageSizeJson.c_str());

    std::string defaultPageSizeId;
    keyword = "media-default";
    if (ParseAttributeToValue<std::string>(response, keyword, defaultPageSizeId, ConvertPageSizeId)) {
        printerCaps.SetPrinterAttrNameAndValue("defaultPageSizeId", defaultPageSizeId.c_str());
    }
}

void ParseQualityAttributes(ipp_t *response, PrinterCapability &printerCaps)
{
    std::string keyword = "print-quality-supported";
    ipp_attribute_t *attrPtr = ippFindAttribute(response, keyword.c_str(), IPP_TAG_ENUM);
    if (attrPtr == nullptr) {
        PRINT_HILOGW("%{public}s missing", keyword.c_str());
        return;
    }
    nlohmann::json supportedQualities = nlohmann::json::array();
    for (int i = 0; i < ippGetCount(attrPtr); i++) {
        nlohmann::json jsonObject;
        jsonObject["quality"] = ippGetInteger(attrPtr, i);
        supportedQualities.push_back(jsonObject);
    }
    std::string attrString = supportedQualities.dump();
    PRINT_HILOGD("%{public}s: %{public}s", keyword.c_str(), attrString.c_str());
    printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), attrString.c_str());
}

void ParseCopiesAttributes(ipp_t *response, PrinterCapability &printerCaps)
{
    ipp_attribute_t *attrPtr = ippFindAttribute(response, "copies-supported", IPP_TAG_RANGE);
    if (attrPtr != nullptr) {
        int upper = 0;
        for (int i = 0; i < ippGetCount(attrPtr); i++) {
            ippGetRange(attrPtr, i, &upper);
        }
        printerCaps.SetPrinterAttrNameAndValue("copies-supported", std::to_string(upper).c_str());
    }
    attrPtr = ippFindAttribute(response, "copies-default", IPP_TAG_INTEGER);
    if (attrPtr != nullptr) {
        printerCaps.SetPrinterAttrNameAndValue("copies-default", std::to_string(ippGetInteger(attrPtr, 0)).c_str());
    }
}

void ParseSupportedResolutionAttribute(ipp_t *response, PrinterCapability &printerCaps)
{
    std::string keyword = "printer-resolution-supported";
    ipp_attribute_t *attrPtr = ippFindAttribute(response, keyword.c_str(), IPP_TAG_RESOLUTION);
    if (attrPtr == nullptr) {
        PRINT_HILOGW("attrPtr is null");
        return;
    }
    int num = ippGetCount(attrPtr);
    PRINT_HILOGD("number of values %{public}d", num);
    nlohmann::json resolutionArray = nlohmann::json::array();
    for (int i = 0; i < num; i++) {
        ipp_res_t units = IPP_RES_PER_INCH;
        int xres = 0;
        int yres = 0;
        xres = ippGetResolution(attrPtr, i, &yres, &units);
        if (xres == 0 || yres == 0) {
            continue;
        }
        if (units == IPP_RES_PER_CM) {
            xres = DpcToDpi(xres);
            yres = DpcToDpi(yres);
        } else if (units != IPP_RES_PER_INCH) {
            PRINT_HILOGW("unknown dpi unit: %{public}d", static_cast<int>(units));
            continue;
        }
        nlohmann::json object;
        object["horizontalDpi"] = xres;
        object["verticalDpi"] = yres;
        resolutionArray.push_back(object);
    }
    printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), resolutionArray.dump().c_str());
}

void ParseDefaultResolutionAttribute(ipp_t *response, PrinterCapability &printerCaps)
{
    std::string keyword = "printer-resolution-default";
    ipp_attribute_t *attrPtr = ippFindAttribute(response, keyword.c_str(), IPP_TAG_RESOLUTION);
    if (attrPtr == nullptr) {
        PRINT_HILOGW("attrPtr is null");
        return;
    }
    int num = ippGetCount(attrPtr);
    PRINT_HILOGD("number of values %{public}d", num);
    for (int i = 0; i < num; i++) {
        ipp_res_t units = IPP_RES_PER_INCH;
        int xres = 0;
        int yres = 0;
        xres = ippGetResolution(attrPtr, i, &yres, &units);
        if (xres == 0 || yres == 0) {
            continue;
        }
        if (units == IPP_RES_PER_CM) {
            xres = DpcToDpi(xres);
            yres = DpcToDpi(yres);
        } else if (units != IPP_RES_PER_INCH) {
            PRINT_HILOGW("unknown dpi unit: %{public}d", static_cast<int>(units));
            continue;
        }
        nlohmann::json object;
        object["horizontalDpi"] = xres;
        object["verticalDpi"] = yres;
        printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), object.dump().c_str());
        break;
    }
}

void ParseMediaColDefaultAttributes(ipp_t *response, PrinterCapability &printerCaps)
{
    ipp_attribute_t *defaultMediaPtr = ippFindAttribute(response, "media-col-default", IPP_TAG_BEGIN_COLLECTION);
    if (defaultMediaPtr == nullptr) {
        PRINT_HILOGW("media-col-default missing");
        return;
    }
    ipp_t *defaultMediaCol = defaultMediaPtr->values[0].collection;
    std::vector<std::string> keywordList;
    keywordList.push_back("media-top-margin");
    keywordList.push_back("media-bottom-margin");
    keywordList.push_back("media-left-margin");
    keywordList.push_back("media-right-margin");
    for (auto &keyword : keywordList) {
        ipp_attribute_t *attrPtr = ippFindAttribute(defaultMediaCol, keyword.c_str(), IPP_TAG_INTEGER);
        if (attrPtr != nullptr) {
            int value = ippGetInteger(attrPtr, 0);
            PRINT_HILOGD("%{public}s found: %{public}d", keyword.c_str(), value);
            std::string defaultKeyword = keyword + "-default";
            printerCaps.SetPrinterAttrNameAndValue(defaultKeyword.c_str(), std::to_string(value).c_str());
        }
    }
    ipp_attribute_t *attrPtr = ippFindAttribute(defaultMediaCol, "duplex-supported", IPP_TAG_BOOLEAN);
    if (attrPtr != nullptr) {
        PRINT_HILOGD("duplex-supported found: %{public}d", ippGetBoolean(attrPtr, 0));
    }
    attrPtr = ippFindAttribute(defaultMediaCol, "media-source", IPP_TAG_KEYWORD);
    if (attrPtr != nullptr) {
        PRINT_HILOGD("media-source-default found: %{public}s", ippGetString(attrPtr, 0, NULL));
        printerCaps.SetPrinterAttrNameAndValue("media-source-default", ippGetString(attrPtr, 0, NULL));
    }
    attrPtr = ippFindAttribute(defaultMediaCol, "media-type", IPP_TAG_KEYWORD);
    if (attrPtr != nullptr) {
        PRINT_HILOGD("media-type-default found: %{public}s", ippGetString(attrPtr, 0, NULL));
        printerCaps.SetPrinterAttrNameAndValue("media-type-default", ippGetString(attrPtr, 0, NULL));
    }
}

void ParseMediaMarginAttributes(ipp_t *response, PrinterCapability &printerCaps)
{
    ipp_attribute_t *attrPtr;
    if ((attrPtr = ippFindAttribute(response, "media-bottom-margin-supported", IPP_TAG_INTEGER)) != NULL) {
        printerCaps.SetPrinterAttrNameAndValue("media-bottom-margin-supported",
            std::to_string(ippGetInteger(attrPtr, 0)).c_str());
    }
    if ((attrPtr = ippFindAttribute(response, "media-top-margin-supported", IPP_TAG_INTEGER)) != NULL) {
        printerCaps.SetPrinterAttrNameAndValue("media-top-margin-supported",
            std::to_string(ippGetInteger(attrPtr, 0)).c_str());
    }
    if ((attrPtr = ippFindAttribute(response, "media-left-margin-supported", IPP_TAG_INTEGER)) != NULL) {
        printerCaps.SetPrinterAttrNameAndValue("media-left-margin-supported",
            std::to_string(ippGetInteger(attrPtr, 0)).c_str());
    }
    if ((attrPtr = ippFindAttribute(response, "media-right-margin-supported", IPP_TAG_INTEGER)) != NULL) {
        printerCaps.SetPrinterAttrNameAndValue("media-right-margin-supported",
            std::to_string(ippGetInteger(attrPtr, 0)).c_str());
    }
}

void ParseOrientationAttributes(ipp_t *response, PrinterCapability &printerCaps)
{
    std::string keyword = "orientation-requested-default";
    ipp_attribute_t *attrPtr = ippFindAttribute(response, keyword.c_str(), IPP_TAG_ENUM);
    if (attrPtr != NULL) {
        int orientationEnum = ippGetInteger(attrPtr, 0);
        printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), std::to_string(orientationEnum).c_str());
        PRINT_HILOGD("orientation-default found: %{public}d", orientationEnum);
    }
    keyword = "orientation-requested-supported";
    attrPtr = ippFindAttribute(response, keyword.c_str(), IPP_TAG_ENUM);
    if (attrPtr != NULL) {
        int num = ippGetCount(attrPtr);
        if (num > 0) {
            nlohmann::json supportedOrientationArray = nlohmann::json::array();
            for (int i = 0; i < ippGetCount(attrPtr); i++) {
                int orientationEnum = ippGetInteger(attrPtr, i);
                supportedOrientationArray.push_back(orientationEnum);
                PRINT_HILOGD("orientation-supported found: %{public}d", orientationEnum);
            }
            printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), supportedOrientationArray.dump().c_str());
        }
    }
}

void ParseOtherAttributes(ipp_t *response, PrinterCapability &printerCaps)
{
    std::string keyword = "media-source-supported";
    std::string attrString = ConvertIppAttributesToJsonString(response, keyword, IPP_TAG_KEYWORD);
    PRINT_HILOGD("%{public}s: %{public}s", keyword.c_str(), attrString.c_str());
    if (!attrString.empty()) {
        printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), attrString.c_str());
    }

    keyword = "multiple-document-handling-supported";
    attrString = ConvertIppAttributesToJsonString(response, keyword, IPP_TAG_KEYWORD);
    PRINT_HILOGD("%{public}s: %{public}s", keyword.c_str(), attrString.c_str());
    if (!attrString.empty()) {
        printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), attrString.c_str());
    }
}

void SetOptionAttribute(ipp_t *response, PrinterCapability &printerCaps)
{
    ipp_attribute_t *attrPtr;
    nlohmann::json options;
    if ((attrPtr = ippFindAttribute(response, "printer-make-and-model", IPP_TAG_TEXT)) != NULL) {
        options["make"] = ippGetString(attrPtr, 0, NULL);
    }
    if ((attrPtr = ippFindAttribute(response, "printer-uuid", IPP_TAG_URI)) != NULL) {
        options["uuid"] = ippGetString(attrPtr, 0, NULL);
    }
    if ((attrPtr = ippFindAttribute(response, "printer-name", IPP_TAG_TEXT)) != NULL) {
        options["printerName"] = ippGetString(attrPtr, 0, NULL);
    }
    std::string keyword = "media-type-supported";
    std::string supportTypes = ConvertIppAttributesToJsonString(response, keyword, IPP_TAG_ZERO);
    PRINT_HILOGD("%{public}s: %{public}s", keyword.c_str(), supportTypes.c_str());
    if (!supportTypes.empty()) {
        printerCaps.SetPrinterAttrNameAndValue(keyword.c_str(), supportTypes.c_str());
    }

    nlohmann::json cupsOptionsJson = printerCaps.GetPrinterAttrGroupJson();
    options["cupsOptions"] = cupsOptionsJson;

    std::string optionStr = options.dump();
    PRINT_HILOGD("SetOption: %{public}s", optionStr.c_str());
    printerCaps.SetOption(optionStr);
}

void ParsePrinterAttributes(ipp_t *response, PrinterCapability &printerCaps)
{
    SetCapabilityGroupAttribute(response, printerCaps);
    ParseColorModeAttributes(response, printerCaps);
    ParseDuplexModeAttributes(response, printerCaps);
    ParsePageSizeAttributes(response, printerCaps);
    ParseQualityAttributes(response, printerCaps);
    ParseSupportedResolutionAttribute(response, printerCaps);
    ParseDefaultResolutionAttribute(response, printerCaps);
    ParseMediaColDefaultAttributes(response, printerCaps);
    ParseMediaMarginAttributes(response, printerCaps);
    ParseOrientationAttributes(response, printerCaps);
    ParseCopiesAttributes(response, printerCaps);
    ParseOtherAttributes(response, printerCaps);
    SetOptionAttribute(response, printerCaps);
}
}  // namespace OHOS::Print