# HG changeset patch
# User Goffi <goffi@goffi.org>
# Date 1448834231 -3600
# Node ID 23560a1cd3976ec7f41f21a3004849d01776c8f4
# Parent  0502a1fbe8b5b1521da354df95ae10920ce56097
plugin welcome: first draft
    this plugin display a welcome message on first connection (or if General/Welcome param is set to True), and have a trigger point if other plugins want to do action on first connection (like adding entities to roster).

diff -r 0502a1fbe8b5 -r 23560a1cd397 src/plugins/plugin_misc_welcome.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/plugins/plugin_misc_welcome.py	Sun Nov 29 22:57:11 2015 +0100
@@ -0,0 +1,93 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# SAT plugin for file tansfer
+# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Jérôme Poisson (goffi@goffi.org)
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from sat.core.i18n import _, D_
+from sat.core.constants import Const as C
+from sat.core.log import getLogger
+log = getLogger(__name__)
+from sat.tools import xml_tools
+
+
+PLUGIN_INFO = {
+    "name": "Welcome",
+    "import_name": "WELCOME",
+    "type": C.PLUG_TYPE_MISC,
+    "main": "Welcome",
+    "handler": "no",
+    "description": _("""Plugin which manage welcome message and things to to on first connection.""")
+}
+
+
+WELCOME_PARAM_CATEGORY = "General"
+WELCOME_PARAM_NAME = "welcome"
+WELCOME_PARAM_LABEL = D_(u"Display welcome message")
+WELCOME_MSG_TITLE = D_(u"Welcome to Libervia/Salut à Toi")
+# XXX: this message is mainly targetting libervia new users for now
+#      (i.e.: it may look weird on other frontends)
+WELCOME_MSG = D_(u"""Welcome to a free (as in freedom) network!
+
+If you have any trouble, or you want to help us for the bug hunting, you can contact us in real time chat by using the “help/official chat room”  menu.
+
+The use Libervia, you'll need to add contacts, either people you know, or people you discover by using the “Service/Search directory” menu.
+
+We hope that you'll enjoy using this project.
+
+The Libervia/Salut à Toi Team
+""")
+
+
+PARAMS = """
+    <params>
+    <individual>
+    <category name="{category}">
+        <param name="{name}" label="{label}" type="bool" />
+    </category>
+    </individual>
+    </params>
+    """.format(category=WELCOME_PARAM_CATEGORY, name=WELCOME_PARAM_NAME, label=WELCOME_PARAM_LABEL)
+
+
+class Welcome(object):
+
+    def __init__(self, host):
+        log.info(_("plugin Welcome initialization"))
+        self.host = host
+        host.memory.updateParams(PARAMS)
+
+    def profileConnected(self, profile):
+        # XXX: if you wan to try first_start again, you'll have to remove manually
+        #      the welcome value from your profile params in sat.db
+        welcome = self.host.memory.params.getParamA(WELCOME_PARAM_NAME, WELCOME_PARAM_CATEGORY, use_default=False, profile_key=profile)
+        if welcome is None:
+            first_start = True
+            welcome = True
+        else:
+            first_start = False
+
+        if welcome:
+            xmlui = xml_tools.note(WELCOME_MSG, WELCOME_MSG_TITLE)
+            self.host.actionNew({'xmlui': xmlui.toXml()}, profile=profile)
+            self.host.memory.setParam(WELCOME_PARAM_NAME, C.BOOL_FALSE, WELCOME_PARAM_CATEGORY, profile_key=profile)
+
+        self.host.trigger.point("WELCOME", first_start, welcome, profile)
+
+
+
+
+