def get_profile(self, profile_gus):
profile_iface = PluginProfiles(self.getStore())
profile_description = profile_iface.get_single(profile_gus)
self.returnData(profile_description)
self.returnCode(200)
return self.prepareRetVals()
def put(self, receiver_token_auth, conf_id, *uriargs):
"""
Parameters:
Parameters: receiver_token_auth, receiver_configuration_id
Request: receiverConfDesc
Response: receiverConfDesc
Errors: InvalidInputFormat, ProfileGusNotFound, ContextGusNotFound, ReceiverGusNotFound,
update the resource ReceiverConf by a specific receiver, and if is requested as active,
deactivate the others related to the same context.
"""
receivertip_iface = ReceiverTip()
try:
request = validateMessage(self.request.body, requests.receiverReceiverDesc)
receivers_map = yield receivertip_iface.get_receivers_by_tip(receiver_token_auth)
user = receivers_map['actor']
# ++ sanity checks that can't be make by validateMessage or by model:
profile_iface = PluginProfiles()
profile_desc = yield profile_iface.get_single(request['profile_gus'])
if profile_desc['plugin_type'] == u'notification' and user['can_configure_notification']:
pass
elif profile_desc['plugin_type'] == u'delivery' and user['can_configure_delivery']:
pass
else:
raise ForbiddenOperation
# -- end of the sanity checks
receivercfg_iface = ReceiverConfs()
config_update = yield receivercfg_iface.update(conf_id, user['receiver_gus'], request)
if config_update['active']:
# keeping active only the last configuration requested
yield receivercfg_iface.deactivate_all_but(config_update['config_id'], config_update['context_gus'],
user['receiver_gus'], config_update['plugin_type'])
self.write(config_update)
self.set_status(200) # OK
except InvalidTipAuthToken, e:
self.set_status(e.http_status)
self.write({'error_message': e.error_message, 'error_code' : e.error_code})
def post(self, receiver_token_auth, *uriargs):
"""
Parameters: receiver_token_auth
Request: receiverConfDesc
Response: receiverConfDesc
Errors: TipGusNotFound, InvalidTipAuthToken, ForbiddenOperation, ContextGusNotFound, ReceiverGusNotFound
Create a new configuration for a plugin
"""
receivertip_iface = ReceiverTip()
try:
request = validateMessage(self.request.body, requests.receiverReceiverDesc)
receivers_map = yield receivertip_iface.get_receivers_by_tip(receiver_token_auth)
user = receivers_map['actor']
# ++ sanity checks that can't be make by validateMessage or by model:
profile_iface = PluginProfiles()
profile_desc = yield profile_iface.get_single(request['profile_gus'])
if profile_desc['plugin_type'] == u'notification' and user['can_configure_notification']:
pass
elif profile_desc['plugin_type'] == u'delivery' and user['can_configure_delivery']:
pass
else:
raise ForbiddenOperation
# -- end of the sanity checks
receivercfg_iface = ReceiverConfs()
config_desc = yield receivercfg_iface.new(user['receiver_gus'], request)
if config_desc['active']:
# keeping active only the last configuration requested
yield receivercfg_iface.deactivate_all_but(config_desc['config_id'], config_desc['context_gus'],
user['receiver_gus'], config_desc['plugin_type'])
self.write(config_desc)
self.set_status(201) # Created
except InvalidTipAuthToken, e:
self.set_status(e.http_status)
self.write({'error_message': e.error_message, 'error_code' : e.error_code})
def comment_notification(self):
plugin_type = u'notification'
store = self.getStore()
comment_iface = Comment(store)
internaltip_iface = InternalTip(store)
receivercfg_iface = ReceiverConfs(store)
profile_iface = PluginProfiles(store)
not_notified_comments = comment_iface.get_comment_by_mark(marker=u'not notified')
for comment in not_notified_comments:
receivers_list = internaltip_iface.get_receivers_by_itip(comment['internaltip_id'])
# needed to obtain context!
itip_info = internaltip_iface.get_single(comment['internaltip_id'])
for receiver_info in receivers_list:
receiver_conf = receivercfg_iface.get_active_conf(receiver_info['receiver_gus'],
itip_info['context_gus'], plugin_type)
if receiver_conf is None:
# TODO applicative log, database tracking of queue
continue
# Ok, we had a valid an appropriate receiver configuration for the notification task
related_profile = profile_iface.get_single(receiver_conf['profile_gus'])
settings_dict = { 'admin_settings' : related_profile['admin_settings'],
'receiver_settings' : receiver_conf['receiver_settings']}
plugin = PluginManager.instance_plugin(related_profile['plugin_name'])
return_code = plugin.do_notify(settings_dict, u'comment', comment)
if return_code:
print "Notification of comment successful for user", receiver_conf['receiver_gus']
else:
print "Notification of comment failed for user", receiver_conf['receiver_gus']
# remind: comment are not guarantee until Task manager is not developed
comment_iface.flip_mark(comment['comment_id'], u'notified')
def tip_notification(self):
plugin_type = u'notification'
store = self.getStore()
receivertip_iface = ReceiverTip(store)
receivercfg_iface = ReceiverConfs(store)
profile_iface = PluginProfiles(store)
not_notified_tips = receivertip_iface.get_tips_by_notification_mark(u'not notified')
for single_tip in not_notified_tips:
# from a single tip, we need to extract the receiver, and then, having
# context + receiver, find out which configuration setting has active
receivers_map = receivertip_iface.get_receivers_by_tip(single_tip['tip_gus'])
receiver_info = receivers_map['actor']
receiver_conf = receivercfg_iface.get_active_conf(receiver_info['receiver_gus'],
single_tip['context_gus'], plugin_type)
if receiver_conf is None:
print "Receiver", receiver_info['receiver_gus'],\
"has not an active notification settings in context", single_tip['context_gus'], "for", plugin_type
# TODO separate key in answer
continue
# Ok, we had a valid an appropriate receiver configuration for the notification task
related_profile = profile_iface.get_single(receiver_conf['profile_gus'])
settings_dict = { 'admin_settings' : related_profile['admin_settings'],
'receiver_settings' : receiver_conf['receiver_settings']}
plugin = PluginManager.instance_plugin(related_profile['plugin_name'])
updated_tip = receivertip_iface.update_notification_date(single_tip['tip_gus'])
return_code = plugin.do_notify(settings_dict, u'tip', updated_tip)
if return_code:
receivertip_iface.flip_mark(single_tip['tip_gus'], u'notified')
else:
receivertip_iface.flip_mark(single_tip['tip_gus'], u'unable to notify')
def get(self, profile_gus, *uriargs):
"""
Parameters: profile_gus
Response: adminProfileDesc
Errors: ProfileGusNotFound
"""
plugin_iface = PluginProfiles()
try:
profile_description = yield plugin_iface.get_single(profile_gus)
self.set_status(200)
self.write(profile_description)
except ProfileGusNotFound, e:
self.set_status(e.http_status)
self.write({'error_message': e.error_message, 'error_code' : e.error_code})
def operation(self):
"""
Goal of this function is to check all the:
Tips
Comment
Folder
System Event
marked as 'not notified' and perform notification.
Notification plugin chose if perform a communication or not,
Then became marked as:
'notification ignored', or
'notified'
Every notification plugin NEED have a checks to verify
if notification has been correctly performed. If not (eg: wrong
login/password, network errors) would be marked as:
'unable to be notified', and a retry logic is in TODO
"""
plugin_type = u'notification'
log.debug("[D]", self.__class__, 'operation', datetime.today().ctime())
receivertip_iface = ReceiverTip()
receivercfg_iface = ReceiverConfs()
profile_iface = PluginProfiles()
# TODO digest check missing it's required refactor the scheduler using a dedicated Storm table
not_notified_tips = yield receivertip_iface.get_tips_by_notification_mark(u'not notified')
for single_tip in not_notified_tips:
# from a single tip, we need to extract the receiver, and then, having
# context + receiver, find out which configuration setting has active
receivers_map = yield receivertip_iface.get_receivers_by_tip(single_tip['tip_gus'])
receiver_info = receivers_map['actor']
receiver_conf = yield receivercfg_iface.get_active_conf(receiver_info['receiver_gus'],
single_tip['context_gus'], plugin_type)
if receiver_conf is None:
print "Receiver", receiver_info['receiver_gus'], \
"has not an active notification settings in context", single_tip['context_gus'], "for", plugin_type
# TODO applicative log, database tracking of queue
continue
# Ok, we had a valid an appropriate receiver configuration for the notification task
related_profile = yield profile_iface.get_single(receiver_conf['profile_gus'])
settings_dict = { 'admin_settings' : related_profile['admin_settings'],
'receiver_settings' : receiver_conf['receiver_settings']}
plugin = PluginManager.instance_plugin(related_profile['plugin_name'])
updated_tip = yield receivertip_iface.update_notification_date(single_tip['tip_gus'])
return_code = plugin.do_notify(settings_dict, u'tip', updated_tip)
if return_code:
yield receivertip_iface.flip_mark(single_tip['tip_gus'], u'notified')
else:
yield receivertip_iface.flip_mark(single_tip['tip_gus'], u'unable to notify')
# Comment Notification here it's just an incomplete version, that never would supports
# digest or retry, until Task manager queue is implemented
comment_iface = Comment()
internaltip_iface = InternalTip()
not_notified_comments = yield comment_iface.get_comment_by_mark(marker=u'not notified')
for comment in not_notified_comments:
receivers_list = yield internaltip_iface.get_receivers_by_itip(comment['internaltip_id'])
# needed to obtain context!
itip_info = yield internaltip_iface.get_single(comment['internaltip_id'])
for receiver_info in receivers_list:
receiver_conf = yield receivercfg_iface.get_active_conf(receiver_info['receiver_gus'],
itip_info['context_gus'], plugin_type)
if receiver_conf is None:
# TODO applicative log, database tracking of queue
continue
# Ok, we had a valid an appropriate receiver configuration for the notification task
related_profile = yield profile_iface.get_single(receiver_conf['profile_gus'])
settings_dict = { 'admin_settings' : related_profile['admin_settings'],
'receiver_settings' : receiver_conf['receiver_settings']}
plugin = PluginManager.instance_plugin(related_profile['plugin_name'])
return_code = plugin.do_notify(settings_dict, u'comment', comment)
if return_code:
print "Notification of comment successful for user", receiver_conf['receiver_gus']
else:
print "Notification of comment failed for user", receiver_conf['receiver_gus']
# remind: comment are not guarantee until Task manager is not developed
yield comment_iface.flip_mark(comment['comment_id'], u'notified')
