dp_activepackages.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * 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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you 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 .
 */

#ifndef INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_MANAGER_DP_ACTIVEPACKAGES_HXX
#define INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_MANAGER_DP_ACTIVEPACKAGES_HXX

#include <config_extensions.h>

#include <sal/config.h>

#include <utility>
#include <vector>

#if HAVE_FEATURE_EXTENSIONS
#include <dp_persmap.h>
#endif


namespace dp_manager {

class ActivePackages {
public:
    struct Data {
        Data(): failedPrerequisites("0")
            {}
        /* name of the temporary file (shared, user extension) or the name of
           the folder of the bundled extension.
           It does not contain the trailing '_' of the folder.
           UTF-8 encoded
        */
        OUString temporaryName;
        /* The file name (shared, user) or the folder name (bundled)
           If the key is the file name, then file name is not encoded.
           If the key is the identifier then the file name is UTF-8 encoded.
         */
        OUString fileName;
        OUString mediaType;
        OUString version;
        /* If this string contains the value according to
           css::deployment::Prerequisites or "0". That is, if
           the value is > 0 then
           the call to XPackage::checkPrerequisites failed.
           In this case the extension must not be registered.
         */
        OUString failedPrerequisites;
    };

    typedef std::vector< std::pair< OUString, Data > > Entries;

    ActivePackages();

    explicit ActivePackages(OUString const & url);

    ~ActivePackages();

    bool has(OUString const & id, OUString const & fileName)
        const;

    bool get(
        Data * data, OUString const & id,
        OUString const & fileName) const;

    Entries getEntries() const;

    void put(OUString const & id, Data const & value);

    void erase(OUString const & id, OUString const & fileName);

private:
    ActivePackages(ActivePackages const &) = delete;
    ActivePackages& operator =(ActivePackages const &) = delete;
#if HAVE_FEATURE_EXTENSIONS
    ::dp_misc::PersistentMap m_map;
#endif
};

}

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */