history.h 2.76 KB
Newer Older
1
/*
2
 *  Copyright (C) 2004-2013 Savoir-Faire Linux Inc.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
 *
 *  Author: Emmanuel Milou <emmanuel.milou@savoirfairelinux.com>
 *  Author: Alexandre Savard <alexandre.savard@savoirfairelinux.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License
 *  along with this program; if not, write to the Free Software
19
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  If you modify this program, or any covered work, by linking or
 *  combining it with the OpenSSL project's OpenSSL library (or a
 *  modified version of that library), containing parts covered by the
 *  terms of the OpenSSL or SSLeay licenses, Savoir-Faire Linux Inc.
 *  grants you additional permission to convey the resulting work.
 *  Corresponding Source for a non-source form of such a combination
 *  shall include the source code for the parts of OpenSSL used as well
 *  as that of the covered work.
 */

#ifndef HISTORY_
#define HISTORY_

#include "historyitem.h"
37
#include <mutex>
38 39 40 41
#include <vector>

class Call;

42 43
namespace sfl {

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
class History {

    public:
        History();
        /** Load history from file */
        bool load(int limit);

        /**
         *@return True if the history has been successfully saved in the file
         */
        bool save();

        /*
         *@return The number of items found in the history file
         */
59
        size_t numberOfItems();
60

61
        bool empty();
62

63
        std::vector<std::map<std::string, std::string> > getSerialized();
64 65 66

        void addCall(Call *call, int limit);
        void clear();
Emeric Vigier's avatar
Emeric Vigier committed
67
        void setPath(const std::string &path);
68
    private:
69
        /* Mutex to protect the history items */
70
        std::mutex historyItemsMutex_;
71

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
        /* If no path has been set, this will initialize path to a
         * system-dependent location */
        void ensurePath();
        /*
         * Add a new history item in the data structure
         */
        void addEntry(const HistoryItem &new_item, int limit);

        /*
         * Vector containing the history items
         */
        std::vector<HistoryItem> items_;

        /* The path to the history file */
        std::string path_;

        friend class HistoryTest;
};

91 92
}

93
#endif // HISTORY_