/* * Retroshare Gxs Support * * Copyright 2012-2013 by Robert Fernie. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License Version 2.1 as published by the Free Software Foundation. * * This library 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 * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA. * * Please report all bugs and problems to "retroshare@lunamutt.com". * */ #ifndef _GXS_GROUP_DIALOG_H #define _GXS_GROUP_DIALOG_H #include "ui_GxsGroupDialog.h" #include "util/TokenQueue.h" /******** * Notes: * * This is a generic Group Dialog, which is expected to be overloaded to include * specific data for a specific service. * * To acheive this, we have a GxsGroupExtension widget * - programmatically added to the GUI. * - called to fill in fields in the Data Structures. * * To enable extension, we have a bunch of flags so various options can * be shown / disabled for each specific service. * - Enabled. * - Defaults. * - ReadOnly * * This form will be used for Create/Edit & View of Group Info. */ class GxsGroupExtension: public QWidget { public: GxsGroupExtension() : QWidget() { return; } }; /*** Group flags affect what is visually enabled that gets input into the grpMeta ***/ #define GXS_GROUP_FLAGS_NAME 0x00000001 #define GXS_GROUP_FLAGS_ICON 0x00000002 #define GXS_GROUP_FLAGS_DESCRIPTION 0x00000004 #define GXS_GROUP_FLAGS_DISTRIBUTION 0x00000008 #define GXS_GROUP_FLAGS_PUBLISHSIGN 0x00000010 #define GXS_GROUP_FLAGS_SHAREKEYS 0x00000020 #define GXS_GROUP_FLAGS_PERSONALSIGN 0x00000040 #define GXS_GROUP_FLAGS_COMMENTS 0x00000080 #define GXS_GROUP_FLAGS_EXTRA 0x00000100 /*** Default flags are used to determine privacy of group, signatures required *** *** whether publish or id and whether comments are allowed or not ***/ #define GXS_GROUP_DEFAULTS_DISTRIB_MASK 0x0000000f #define GXS_GROUP_DEFAULTS_PUBLISH_MASK 0x000000f0 #define GXS_GROUP_DEFAULTS_PERSONAL_MASK 0x00000f00 #define GXS_GROUP_DEFAULTS_COMMENTS_MASK 0x0000f000 #define GXS_GROUP_DEFAULTS_DISTRIB_PUBLIC 0x00000001 #define GXS_GROUP_DEFAULTS_DISTRIB_GROUP 0x00000002 #define GXS_GROUP_DEFAULTS_DISTRIB_LOCAL 0x00000004 #define GXS_GROUP_DEFAULTS_PUBLISH_OPEN 0x00000010 #define GXS_GROUP_DEFAULTS_PUBLISH_THREADS 0x00000020 #define GXS_GROUP_DEFAULTS_PUBLISH_REQUIRED 0x00000040 #define GXS_GROUP_DEFAULTS_PUBLISH_ENCRYPTED 0x00000080 #define GXS_GROUP_DEFAULTS_PERSONAL_PGP 0x00000100 #define GXS_GROUP_DEFAULTS_PERSONAL_REQUIRED 0x00000200 #define GXS_GROUP_DEFAULTS_PERSONAL_IFNOPUB 0x00000400 #define GXS_GROUP_DEFAULTS_COMMENTS_YES 0x00001000 #define GXS_GROUP_DEFAULTS_COMMENTS_NO 0x00002000 /*! * The aim of this dialog is to be convenient to encapsulate group * creation code for several GXS services such forums, channels * and posted * The functionality provided are for group creation are: * - Specifying the authentication type of the group * - Specifying group image * - * The main limitation is that it will not deal with the actual service GXS Group * data structure, but the meta structure which is the same across GXS services * The long term plan is perhap logic structure (i.e. code) will be moved into each GXS \n * service for better customisation of group creation, or perhaps not! */ class GxsGroupDialog : public QDialog, public TokenResponse { Q_OBJECT public: enum Mode { MODE_CREATE, MODE_SHOW, MODE_EDIT }; enum UiType { UITYPE_SERVICE_HEADER, UITYPE_KEY_SHARE_CHECKBOX, UITYPE_CONTACTS_DOCK, UITYPE_BUTTONBOX_OK }; public: /*! * Constructs a GxsGroupDialog for creating group * @param tokenQueue This should be the TokenQueue of the (parent) service * in order to receive acknowledgement of group creation, if set to NULL with create mode \n * creation will not happen * @param enableFlags This determines what options are enabled such as Icon, Description, publish type and key sharing * @param defaultFlags This deter * @param parent The parent dialog * @param mode */ GxsGroupDialog(TokenQueue* tokenQueue, uint32_t enableFlags, uint32_t defaultFlags, QWidget *parent = NULL); /*! * Contructs a GxsGroupDialog for display a group or editing * @param grpMeta This is used to fill out the dialog * @param mode This determines whether the dialog starts in show or edit mode (Edit not supported yet) * @param parent */ GxsGroupDialog(TokenQueue *tokenExternalQueue, RsTokenService *tokenService, Mode mode, RsGxsGroupId groupId, uint32_t enableFlags, uint32_t defaultFlags, QWidget *parent = NULL); uint32_t mode() { return mMode; } // overloaded from TokenResponse virtual void loadRequest(const TokenQueue *queue, const TokenRequest &req); private: void newGroup(); void init(); void initMode(); void createNewGxsId(); // Functions that can be overloaded for specific stuff. protected slots: void submitGroup(); void addGroupLogo(); protected: virtual void showEvent(QShowEvent*); virtual void initUi() = 0; virtual QPixmap serviceImage() = 0; virtual QIcon serviceWindowIcon(); void setUiText(UiType uiType, const QString &text); /*! * It is up to the service to do the actual group creation * Service can also modify initial meta going into group * @param token This should be set to the token retrieved * @param meta The deriving GXS service should set their grp meta to this value */ virtual bool service_CreateGroup(uint32_t &token, const RsGroupMetaData &meta) = 0; /*! * It is up to the service to do the actual group editing * @param token This should be set to the token retrieved * @param meta The deriving GXS service should set their grp meta to this value */ virtual bool service_EditGroup(uint32_t &token, RsGroupMetaData &editedMeta) = 0; // To be overloaded by users. // use Token to retrieve from service, fill in metaData. virtual bool service_loadGroup(uint32_t token, Mode mode, RsGroupMetaData& groupMetaData, QString &description) = 0; /*! * This returns a group logo from the ui \n * Should be calleld by deriving service * @return The logo for the service */ QPixmap getLogo(); /*! * This sets a group logo into the ui \n * Should be calleld by deriving service * @param pixmap */ void setLogo(const QPixmap &pixmap); /*! * This returns a group name string from the ui * @return group name string */ QString getName(); /*! * This returns a group description string from the ui * @return group description string */ QString getDescription(); private slots: /* actions to take.... */ void cancelDialog(); // set private forum key share list void setShareList(); void updateCircleOptions(); private: bool setCircleParameters(RsGroupMetaData &meta); void setGroupSignFlags(uint32_t signFlags); uint32_t getGroupSignFlags(); void setAllReadonly(); void setupReadonly(); void setupDefaults(); void setupVisibility(); void clearForm(); void createGroup(); void editGroup(); void sendShareList(std::string forumId); void loadNewGroupId(const uint32_t &token); // loading existing Groups. void requestGroup(const RsGxsGroupId &groupId); void loadGroup(uint32_t token); void updateFromExistingMeta(const QString &description); bool prepareGroupMetaData(RsGroupMetaData &meta); std::list mShareList; QPixmap mPicture; RsTokenService *mTokenService; TokenQueue *mExternalTokenQueue; TokenQueue *mInternalTokenQueue; RsGroupMetaData mGrpMeta; Mode mMode; uint32_t mEnabledFlags; uint32_t mReadonlyFlags; uint32_t mDefaultsFlags; protected: /** Qt Designer generated object */ Ui::GxsGroupDialog ui; }; #endif