def update_receiversetting(self, receiver_gus, conf_id, request, receiver_desc=None):
store = self.getStore()
profile_desc = PluginProfiles(store).get_single(request['profile_gus'])
# Admin do not pass receiver_desc, and then is not checked capability
if not receiver_desc:
pass
elif profile_desc['plugin_type'] == u'notification' and receiver_desc['can_configure_notification']:
pass
elif profile_desc['plugin_type'] == u'delivery' and receiver_desc['can_configure_delivery']:
pass
else:
raise ForbiddenOperation
receivercfg_iface = ReceiverConfs(store)
config_update = receivercfg_iface.update(conf_id, receiver_gus, request)
if config_update['active']:
# keeping active only the last configuration requested
receivercfg_iface.deactivate_all_but(config_update['config_id'], config_update['context_gus'],
receiver_gus, config_update['plugin_type'])
self.returnData(config_update)
self.returnCode(200)
return self.prepareRetVals()
def delete(self, receiver_token_auth, conf_id, *uriargs):
"""
Parameters: receiver_token_auth, receiver_configuration_id
Request: receiverProfileDesc
Response: None
Errors: InvalidInputFormat, ProfileGusNotFound
"""
receivertip_iface = ReceiverTip()
try:
# TODO validate parameters or raise InvalidInputFormat
receivers_map = yield receivertip_iface.get_receivers_by_tip(receiver_token_auth)
user = receivers_map['actor']
receivercfg_iface = ReceiverConfs()
yield receivercfg_iface.delete(conf_id, user['receiver_gus'])
self.set_status(200) # OK
except TipGusNotFound, e:
self.set_status(e.http_status)
self.write({'error_message': e.error_message, 'error_code' : e.error_code})
def get(self, receiver_token_auth, rconf_id, *uriargs):
"""
Parameters: receiver_token_auth, receiver_configuration_id
Response: receiverConfDesc
Errors: InvalidInputFormat, ProfileGusNotFound, TipGusNotFound, InvalidTipAuthToken
"""
receivertip_iface = ReceiverTip()
try:
# TODO receiver_token_auth and rconf_id validation
receivers_map = yield receivertip_iface.get_receivers_by_tip(receiver_token_auth)
user = receivers_map['actor']
receivercfg_iface = ReceiverConfs()
conf_requested = yield receivercfg_iface.get_single(rconf_id)
self.write(conf_requested)
# TODO output filtering, creating a receiverConfDesc
self.set_status(200)
except TipGusNotFound, e:
self.set_status(e.http_status)
self.write({'error_message': e.error_message, 'error_code' : e.error_code})
def delete_receiver(self, receiver_gus):
store = self.getStore()
receiver_iface = Receiver(store)
receiver_desc = receiver_iface.get_single(receiver_gus)
receivertip_iface = ReceiverTip(store)
# Remove Tip possessed by the receiver
related_tips = receivertip_iface.get_tips_by_receiver(receiver_gus)
for tip in related_tips:
receivertip_iface.personal_delete(tip['tip_gus'])
# Remind: the comment are kept, and the name do not use a reference
# but is stored in the comment entry.
context_iface = Context(store)
# Just an alignment check that need to be removed
contexts_associated = context_iface.get_contexts_by_receiver(receiver_gus)
print "context associated by receiver POV:", len(contexts_associated),\
"context associated by receiver-DB field:", len(receiver_desc['contexts'])
context_iface.align_receiver_delete(receiver_desc['contexts'], receiver_gus)
receiverconf_iface = ReceiverConfs(store)
receivercfg_list = receiverconf_iface.get_confs_by_receiver(receiver_gus)
for rcfg in receivercfg_list:
receiverconf_iface.delete(rcfg['config_id'], receiver_gus)
# Finally delete the receiver
receiver_iface.receiver_delete(receiver_gus)
self.returnData(receiver_desc)
self.returnCode(200)
return self.prepareRetVals()
def get(self, what, *uriargs):
"""
Parameters: None
Response: Unknown
Errors: None
/admin/overview GET should return up to all the tables of GLBackend
"""
from globaleaks.models.externaltip import ReceiverTip, WhistleblowerTip, Comment
from globaleaks.models.options import PluginProfiles, ReceiverConfs
from globaleaks.models.internaltip import InternalTip
from globaleaks.models.receiver import Receiver
expected = [ 'itip', 'wtip', 'rtip', 'receivers', 'comment', 'profiles', 'rcfg', 'all' ]
if what == 'receivers' or what == 'all':
receiver_iface = Receiver()
receiver_list = yield receiver_iface.admin_get_all()
self.write({ 'elements' : len(receiver_list), 'receivers' : receiver_list})
if what == 'itip' or what == 'all':
itip_iface = InternalTip()
itip_list = yield itip_iface.admin_get_all()
self.write({ 'elements' : len(itip_list), 'internaltips' : itip_list })
if what == 'rtip' or what == 'all':
rtip_iface = ReceiverTip()
rtip_list = yield rtip_iface.admin_get_all()
self.write({ 'elements' : len(rtip_list), 'receivers_tips' : rtip_list })
if what == 'wtip' or what == 'all':
wtip_iface = WhistleblowerTip()
wtip_list = yield wtip_iface.admin_get_all()
self.write({ 'elements' : len(wtip_list), 'whistleblower_tips' : wtip_list })
if what == 'comment' or what == 'all':
comment_iface = Comment()
comment_list = yield comment_iface.admin_get_all()
self.write({ 'elements' : len(comment_list), 'comments' : comment_list })
if what == 'profiles' or what == 'all':
profile_iface = PluginProfiles()
profile_list = yield profile_iface.admin_get_all()
self.write({ 'elements' : len(profile_list), 'profiles' : profile_list })
if what == 'rcfg' or what == 'all':
rconf_iface = ReceiverConfs()
rconf_list = yield rconf_iface.admin_get_all()
self.write({ 'elements' : len(rconf_list), 'settings' : rconf_list })
if not what in expected:
self.set_status(405)
else:
self.set_status(200)
self.finish()
def get_receiversetting_list(self, receiver_gus):
store = self.getStore()
receivercfg_iface = ReceiverConfs(store)
confs_created = receivercfg_iface.get_confs_by_receiver(receiver_gus)
self.returnData(confs_created)
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 delete(self, receiver_gus, *uriargs):
"""
Parameter: receiver_gus
Request: None
Response: None
Errors: InvalidInputFormat, ReceiverGusNotFound
"""
receiver_iface = Receiver()
try:
# TODO parameter receiver_gus validation - InvalidInputFormat
receiver_desc = yield receiver_iface.get_single(receiver_gus)
receivertip_iface = ReceiverTip()
# Remove Tip possessed by the receiver
related_tips = yield receivertip_iface.get_tips_by_receiver(receiver_gus)
for tip in related_tips:
yield receivertip_iface.personal_delete(tip['tip_gus'])
# Remind: the comment are kept, and the name is not referenced but stored
# in the comment entry.
context_iface = Context()
# TODO make an app log
contexts_associated = yield context_iface.get_contexts_by_receiver(receiver_gus)
print "context associated by receiver POV:", len(contexts_associated),\
"context associated by receiver-DB field:", len(receiver_desc['contexts'])
yield context_iface.align_receiver_delete(receiver_desc['contexts'], receiver_gus)
receiverconf_iface = ReceiverConfs()
# Delete all the receiver configuration associated TODO - App log an number of RCFGs
receivercfg_list = yield receiverconf_iface.get_confs_by_receiver(receiver_gus)
for rcfg in receivercfg_list:
yield receiverconf_iface.delete(rcfg['config_id'], receiver_gus)
# Finally delete the receiver
yield receiver_iface.receiver_delete(receiver_gus)
self.set_status(200)
except ReceiverGusNotFound, e:
self.set_status(e.http_status)
self.write({'error_message': e.error_message, 'error_code' : e.error_code})
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, receiver_token_auth, *uriargs):
"""
Parameters: receiver_token_auth
Response: receiverConfList
Errors: TipGusNotFound, InvalidTipAuthToken
"""
receivertip_iface = ReceiverTip()
try:
receivers_map = yield receivertip_iface.get_receivers_by_tip(receiver_token_auth)
user = receivers_map['actor']
receivercfg_iface = ReceiverConfs()
confs_created = yield receivercfg_iface.get_confs_by_receiver(user['receiver_gus'])
self.write(json.dumps(confs_created))
self.set_status(200)
except TipGusNotFound, e:
self.set_status(e.http_status)
self.write({'error_message': e.error_message, 'error_code' : e.error_code})
def get(self, what, *uriargs):
"""
Parameters: None
Response: Unknown
Errors: None
/dump/overview GET should return up to all the tables of GLBackend
"""
expected = [ 'itip', 'wtip', 'rtip', 'receivers', 'comment',
'profiles', 'rcfg', 'file', 'submission', 'contexts', 'plugins', 'all', 'count' ]
outputDict = {}
if what == 'receivers' or what == 'all' or what == 'count':
receiver_iface = Receiver()
receiver_list = yield receiver_iface.get_all()
if what != 'count':
outputDict.update({ 'receivers_elements' : len(receiver_list), 'receivers' : receiver_list})
else:
outputDict.update({ 'receivers_elements' : len(receiver_list)})
if what == 'itip' or what == 'all' or what == 'count':
itip_iface = InternalTip()
itip_list = yield itip_iface.get_all()
if what != 'count':
outputDict.update({ 'internaltips_elements' : len(itip_list), 'internaltips' : itip_list })
else:
outputDict.update({ 'internaltips_elements' : len(itip_list)})
if what == 'rtip' or what == 'all' or what == 'count':
rtip_iface = ReceiverTip()
rtip_list = yield rtip_iface.get_all()
if what != 'count':
outputDict.update({ 'rtip_elements' : len(rtip_list), 'receivers_tips' : rtip_list })
else:
outputDict.update({ 'rtip_elements' : len(rtip_list)})
if what == 'wtip' or what == 'all' or what == 'count':
wtip_iface = WhistleblowerTip()
wtip_list = yield wtip_iface.get_all()
if what != 'count':
outputDict.update({ 'wtip_elements' : len(wtip_list), 'whistleblower_tips' : wtip_list })
else:
outputDict.update({ 'wtip_elements' : len(wtip_list)})
if what == 'comment' or what == 'all' or what == 'count':
comment_iface = Comment()
comment_list = yield comment_iface.get_all()
if what != 'count':
outputDict.update({ 'comment_elements' : len(comment_list), 'comments' : comment_list })
else:
outputDict.update({ 'comment_elements' : len(comment_list)})
if what == 'profiles' or what == 'all' or what == 'count':
profile_iface = PluginProfiles()
profile_list = yield profile_iface.get_all()
if what != 'count':
outputDict.update({ 'profiles_elements' : len(profile_list), 'profiles' : profile_list })
else:
outputDict.update({ 'profiles_elements' : len(profile_list)})
if what == 'plugins' or what == 'all' or what == 'count':
plugin_list = yield PluginManager.get_all()
if what != 'count':
outputDict.update({ 'plugins_elements' : len(plugin_list), 'plugins' : plugin_list })
else:
outputDict.update({ 'plugins_elements' : len(plugin_list) })
if what == 'rcfg' or what == 'all' or what == 'count':
rconf_iface = ReceiverConfs()
rconf_list = yield rconf_iface.get_all()
if what != 'count':
outputDict.update({ 'rcfg_elements' : len(rconf_list), 'settings' : rconf_list })
else:
outputDict.update({ 'rcfg_elements' : len(rconf_list)})
if what == 'submission' or what == 'all' or what == 'count':
submission_iface = Submission()
submission_list = yield submission_iface.get_all()
if what != 'count':
outputDict.update({ 'submission_elements' : len(submission_list), 'submissions' : submission_list })
else:
outputDict.update({ 'submission_elements' : len(submission_list)})
if what == 'file' or what == 'all' or what == 'count':
file_iface = File()
file_list = yield file_iface.get_all()
if what != 'count':
outputDict.update({ 'file_elements' : len(file_list), 'files' : file_list })
else:
outputDict.update({ 'file_elements' : len(file_list)})
if what == 'contexts' or what == 'all' or what == 'count':
context_iface = Context()
context_list = yield context_iface.get_all()
if what != 'count':
outputDict.update({ 'contexts_elements' : len(context_list), 'contexts' : context_list })
else:
outputDict.update({ 'contexts_elements' : len(context_list)})
if not what in expected:
self.set_status(405)
else:
self.set_status(200)
self.write(outputDict)
self.finish()
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')
