Plugin structure definition

10caret100 · December 28, 2019, 11:46am

(I studied the PayPal plugin, but ) I still can’t grasp the overall “architecture” of how one defines where one’s plugin should “show up” at and under what conditions.

For example, I want to create a plugin, that’ll create and process Invoices, and I want a link to its main “page” to show up inside both the Event left-side menu (as Invoices among Settings, Timetable, Protection, Organization, etc.), and the top main menu (between Room Booking, and My Profile, for example).

Any pointers will be much appreciated!

ThiefMaster · December 28, 2019, 11:49am

I think I already explained it in another thread: You need to connect to the signals used to get the data for those menus. If you search for 'top-menu' and 'event-management-sidemenu' you’ll find lots of code.

10caret100 · December 28, 2019, 11:52am

Sorry @ThiefMaster - I am still confused about all this. Learning, so I might have forgotten something you’ve already explained previously. Things are probably much architecturally simpler than I am assuming, hence my struggling to grasp it all rather quickly Thanks

ThiefMaster · December 28, 2019, 12:04pm

Top menu

github.com

indico/indico-plugins-cern/blob/master/audiovisual/indico_audiovisual/plugin.py#L116


    self.connect(signals.agreements.get_definitions, self._get_agreement_definitions)
    self.connect(signals.acl.can_access, self._can_access_event, sender=Event)
    self.connect(signals.event.type_changed, self._data_changed)
    self.connect(signals.event.updated, self._event_updated)
    self.connect(signals.event.contribution_updated, self._data_changed)
    self.connect(signals.event.subcontribution_updated, self._data_changed)
    self.connect(signals.event.timetable_entry_updated, self._data_changed)
    self.connect(signals.event.times_changed, self._times_changed, sender=Contribution)
    self.connect(signals.event.times_changed, self._times_changed, sender=Event)
    self.connect(signals.after_process, self._apply_changes)
    self.connect(signals.menu.items, self._extend_top_menu, sender='top-menu')
    self.connect(signals.users.merged, self._merge_users)
    self.connect(signals.get_placeholders, self._get_placeholders, sender='agreement-email')
    self.template_hook('event-header', self._inject_event_header)
    self.template_hook('conference-header-subtitle', self._inject_conference_header_subtitle)
    HTTPAPIHook.register(AVExportHook)
    HTTPAPIHook.register(RecordingLinkAPI)


def get_blueprints(self):
    yield blueprint
    yield compat_blueprint

github.com

indico/indico-plugins-cern/blob/master/audiovisual/indico_audiovisual/plugin.py#L201-L205


def _extend_top_menu(self, sender, **kwargs):
    if not session.user or not is_av_manager(session.user):
        return
    return TopMenuItem('services-cern-audiovisual', _('Webcast/Recording'),
                       url_for_plugin('audiovisual.request_list'), section='services')

Event management side menu

github.com

indico/indico-plugins/blob/master/piwik/indico_piwik/plugin.py#L52


    'server_api_url': u'//127.0.0.1/piwik/',
    'server_token': u'',
    'site_id_general': 1,
    'site_id_events': 2,
    'cache_ttl': 3600,
    'use_only_server_url': True,
}


def init(self):
    super(PiwikPlugin, self).init()
    self.connect(signals.menu.items, self.add_sidemenu_item, sender='event-management-sidemenu')
    self.connect(signals.attachments.attachment_accessed, self.track_download)
    self.template_hook('html-head', self.inject_tracking)


def inject_tracking(self, **kwargs):
    server_url = self._get_tracking_url()
    site_id_general = self.settings.get('site_id_general')
    if not self.settings.get('enabled') or not server_url or not site_id_general:
        return ''
    event_tracking_params = self._get_event_tracking_params()
    return render_plugin_template('tracking.html',

github.com

indico/indico-plugins/blob/master/piwik/indico_piwik/plugin.py#L67-L70


def add_sidemenu_item(self, sender, event, **kwargs):
    if not event.can_manage(session.user) or not PiwikPlugin.settings.get('site_id_events'):
        return
    return SideMenuItem(u'statistics', _(u"Statistics"), url_for_plugin(u'piwik.view', event), section=u'reports')

10caret100 · December 28, 2019, 12:09pm

Great reference! Thank you!