granicus.if.org Git - icinga2/blob - lib/livestatus/table.hpp

   1 /******************************************************************************
   2  * Icinga 2                                                                   *
   3  * Copyright (C) 2012-2018 Icinga Development Team (https://www.icinga.com/)  *
   4  *                                                                            *
   5  * This program is free software; you can redistribute it and/or              *
   6  * modify it under the terms of the GNU General Public License                *
   7  * as published by the Free Software Foundation; either version 2             *
   8  * of the License, or (at your option) any later version.                     *
   9  *                                                                            *
  10  * This program is distributed in the hope that it will be useful,            *
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
  13  * GNU General Public License for more details.                               *
  14  *                                                                            *
  15  * You should have received a copy of the GNU General Public License          *
  16  * along with this program; if not, write to the Free Software Foundation     *
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
  18  ******************************************************************************/
  19
  20 #ifndef TABLE_H
  21 #define TABLE_H
  22
  23 #include "livestatus/column.hpp"
  24 #include "base/object.hpp"
  25 #include "base/dictionary.hpp"
  26 #include "base/array.hpp"
  27 #include <vector>
  28
  29 namespace icinga
  30 {
  31
  32 struct LivestatusRowValue {
  33         Value Row;
  34         LivestatusGroupByType GroupByType;
  35         Value GroupByObject;
  36 };
  37
  38 typedef std::function<bool (const Value&, LivestatusGroupByType, const Object::Ptr&)> AddRowFunction;
  39
  40 class Filter;
  41
  42 /**
  43  * @ingroup livestatus
  44  */
  45 class Table : public Object
  46 {
  47 public:
  48         DECLARE_PTR_TYPEDEFS(Table);
  49
  50         static Table::Ptr GetByName(const String& name, const String& compat_log_path = "", const unsigned long& from = 0, const unsigned long& until = 0);
  51
  52         virtual String GetName() const = 0;
  53         virtual String GetPrefix() const = 0;
  54
  55         std::vector<LivestatusRowValue> FilterRows(const intrusive_ptr<Filter>& filter, int limit = -1);
  56
  57         void AddColumn(const String& name, const Column& column);
  58         Column GetColumn(const String& name) const;
  59         std::vector<String> GetColumnNames() const;
  60
  61         LivestatusGroupByType GetGroupByType() const;
  62
  63 protected:
  64         Table(LivestatusGroupByType type = LivestatusGroupByNone);
  65
  66         virtual void FetchRows(const AddRowFunction& addRowFn) = 0;
  67
  68         static Value ZeroAccessor(const Value&);
  69         static Value OneAccessor(const Value&);
  70         static Value EmptyStringAccessor(const Value&);
  71         static Value EmptyArrayAccessor(const Value&);
  72         static Value EmptyDictionaryAccessor(const Value&);
  73
  74         LivestatusGroupByType m_GroupByType;
  75         Value m_GroupByObject;
  76
  77 private:
  78         std::map<String, Column> m_Columns;
  79
  80         bool FilteredAddRow(std::vector<LivestatusRowValue>& rs, const intrusive_ptr<Filter>& filter, int limit, const Value& row, LivestatusGroupByType groupByType, const Object::Ptr& groupByObject);
  81 };
  82
  83 }
  84
  85 #endif /* TABLE_H */
  86
  87 #include "livestatus/filter.hpp"