mirror of
https://github.com/processone/ejabberd.git
synced 2024-11-24 16:23:40 +01:00
8d5025076f
Add a command for keeping only the specified number of items on each node and removing all older items. This might be especially useful if nodes may be configured to have no 'max_items' limit. Thanks to Ammonit Measurement GmbH for sponsoring this work.
107 lines
3.1 KiB
Erlang
107 lines
3.1 KiB
Erlang
%%%----------------------------------------------------------------------
|
|
%%% File : gen_pubsub_nodetree.erl
|
|
%%% Author : Christophe Romain <christophe.romain@process-one.net>
|
|
%%% Purpose : Define the pubsub node tree plugin behaviour
|
|
%%% Created : 1 Dec 2007 by Christophe Romain <christophe.romain@process-one.net>
|
|
%%%
|
|
%%%
|
|
%%% ejabberd, Copyright (C) 2002-2021 ProcessOne
|
|
%%%
|
|
%%% 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 2 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 Foundation, Inc.,
|
|
%%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
%%%
|
|
%%%----------------------------------------------------------------------
|
|
|
|
-module(gen_pubsub_nodetree).
|
|
|
|
|
|
-type(host() :: mod_pubsub:host()).
|
|
-type(nodeId() :: mod_pubsub:nodeId()).
|
|
-type(nodeIdx() :: mod_pubsub:nodeIdx()).
|
|
-type(pubsubNode() :: mod_pubsub:pubsubNode()).
|
|
-type(nodeOptions() :: mod_pubsub:nodeOptions()).
|
|
|
|
-callback init(Host :: host(),
|
|
ServerHost :: binary(),
|
|
Opts :: [any()]) -> atom().
|
|
|
|
-include_lib("xmpp/include/xmpp.hrl").
|
|
|
|
-callback terminate(Host :: host(), ServerHost :: binary()) -> atom().
|
|
|
|
-callback options() -> nodeOptions().
|
|
|
|
-callback set_node(PubsubNode :: pubsubNode()) ->
|
|
ok | {result, NodeIdx::nodeIdx()} | {error, stanza_error()}.
|
|
|
|
-callback get_node(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
From :: jid:jid()) ->
|
|
pubsubNode() |
|
|
{error, stanza_error()}.
|
|
|
|
-callback get_node(Host :: host(),
|
|
NodeId :: nodeId()) ->
|
|
pubsubNode() |
|
|
{error, stanza_error()}.
|
|
|
|
-callback get_node(NodeIdx :: nodeIdx()) ->
|
|
pubsubNode() |
|
|
{error, stanza_error()}.
|
|
|
|
-callback get_nodes(Host :: host(),
|
|
Limit :: non_neg_integer() | infinity)->
|
|
[pubsubNode()].
|
|
|
|
-callback get_nodes(Host :: host())->
|
|
[pubsubNode()].
|
|
|
|
-callback get_all_nodes(Host :: host()) ->
|
|
[pubsubNode()].
|
|
|
|
-callback get_parentnodes(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
From :: jid:jid()) ->
|
|
[pubsubNode()] |
|
|
{error, stanza_error()}.
|
|
|
|
-callback get_parentnodes_tree(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
From :: jid:jid()) ->
|
|
[{0, [pubsubNode(),...]}].
|
|
|
|
-callback get_subnodes(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
Limit :: non_neg_integer() | infinity) ->
|
|
[pubsubNode()].
|
|
|
|
-callback get_subnodes_tree(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
From :: jid:jid()) ->
|
|
[pubsubNode()].
|
|
|
|
-callback create_node(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
Type :: binary(),
|
|
Owner :: jid:jid(),
|
|
Options :: nodeOptions(),
|
|
Parents :: [nodeId()]) ->
|
|
{ok, NodeIdx::nodeIdx()} |
|
|
{error, stanza_error()} |
|
|
{error, {virtual, {host(), nodeId()} | nodeId()}}.
|
|
|
|
-callback delete_node(Host :: host(),
|
|
NodeId :: nodeId()) ->
|
|
[pubsubNode()].
|