XrdHttpChecksumHandler.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of XrdHTTP: A pragmatic implementation of the
// HTTP/WebDAV protocol for the Xrootd framework
//
// Copyright (c) 2013 by European Organization for Nuclear Research (CERN)
// Author: Cedric Caffy <ccaffy@cern.ch>
// File Date: Mar 2023
//------------------------------------------------------------------------------
// XRootD is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------
#ifndef XROOTD_XRDHTTPCHECKSUMHANDLER_HH
#define XROOTD_XRDHTTPCHECKSUMHANDLER_HH
 
#include "XrdHttpChecksum.hh"
 
#include <string>
#include <map>
#include <vector>
#include <memory>
#include <cstdint>

class XrdHttpChecksumHandlerImpl {
public:
    using XrdHttpChecksumPtr = std::unique_ptr<XrdHttpChecksum>;
    using XrdHttpChecksumRawPtr = XrdHttpChecksum *;
 
    XrdHttpChecksumHandlerImpl() = default;
 
    void configure(const char * csList);
    XrdHttpChecksumRawPtr getChecksumToRunWantDigest(const std::string & wantDigest) const;
    XrdHttpChecksumRawPtr getChecksumToRunWantReprDigest(const std::map<std::string,uint8_t> & wantReprDigest) const;
    const std::vector<std::string> & getNonIANAConfiguredCksums() const;
    const std::vector<XrdHttpChecksumRawPtr> & getConfiguredChecksums() const;
private:
    void initializeXRootDConfiguredCksums(const char *csList);
    static void initializeCksumsMaps();
    static void addChecksumToMaps(XrdHttpChecksumPtr && checksum);
    static std::string getElement(const std::string & input, const std::string & delimiter, const size_t position);
    static std::vector<std::string> getUserDigests(const std::string & userDigests);
 
    //The map that containing all possible IANA-HTTP-compatible xrootd checksums
    static std::map<std::string,XrdHttpChecksumPtr> XROOTD_DIGEST_NAME_TO_CKSUMS;
    // The vector of IANA-HTTP-compatible configured checksum
    std::vector<XrdHttpChecksumRawPtr> mConfiguredChecksums;
    // The vector of non-HTTP configured checksum names (for testing purposes)
    std::vector<std::string> mNonIANAConfiguredChecksums;
};

class XrdHttpChecksumHandler {
public:
    using XrdHttpChecksumRawPtr = XrdHttpChecksumHandlerImpl::XrdHttpChecksumRawPtr;
 
    XrdHttpChecksumHandler() = default;
    void configure(const char * csList) { pImpl.configure(csList); }
    XrdHttpChecksumRawPtr getChecksumToRunWantDigest(const std::string & wantDigest) const { return pImpl.getChecksumToRunWantDigest(wantDigest); }

    XrdHttpChecksumRawPtr getChecksumToRunWantReprDigest(const std::map<std::string,uint8_t> & wantReprDigest) const { return pImpl.getChecksumToRunWantReprDigest(wantReprDigest); }

    const std::vector<std::string> & getNonIANAConfiguredCksums() const { return pImpl.getNonIANAConfiguredCksums(); }
private:
    XrdHttpChecksumHandlerImpl pImpl;
};
 
 
#endif //XROOTD_XRDHTTPCHECKSUMHANDLER_HH