def _publish_renditions(self, item, rel, guid):
"""Publish item renditions."""
images = []
renditions = item.get('renditions', {})
original = renditions.get('original')
crop_service = CropService()
for rendition_name, rendition in renditions.items():
crop = get_crop(rendition)
rend_spec = crop_service.get_crop_by_name(rendition_name)
if crop and rend_spec:
file_name = '%s/%s/%s' % (guid, rel, rendition_name)
rendition['media'] = app.media.media_id(file_name, original.get('mimetype'))
rendition['href'] = app.media.url_for_media(rendition['media'], original.get('mimetype'))
rendition['width'] = rend_spec.get('width')
rendition['height'] = rend_spec.get('height')
rendition['ratio'] = rend_spec.get('ratio')
rendition['mimetype'] = original.get('mimetype')
images.append({
'rendition': rendition_name,
'file_name': file_name,
'media': rendition['media'],
'spec': rend_spec,
'crop': crop,
})
publish_images.delay(images=images, original=original, item=item)
def on_update(self, updates, original):
"""Runs on archive update.
Overridden to validate the updates to the article and take necessary actions depending on the updates. In brief,
it does the following:
1. Sets state, item operation, version created, version creator, sign off and word count.
2. Resets Item Expiry
3. If the request is to de-schedule then checks and de-schedules the associated Takes Package also.
4. Creates Crops if article is a picture
"""
user = get_user()
self._validate_updates(original, updates, user)
if PUBLISH_SCHEDULE in updates and original[
ITEM_STATE] == CONTENT_STATE.SCHEDULED:
# check if there is a takes package and deschedule the takes package.
takes_service = TakesPackageService()
package = takes_service.get_take_package(original)
if package and package.get(ITEM_STATE) == CONTENT_STATE.SCHEDULED:
get_resource_service('published').delete_by_article_id(
package.get(config.ID_FIELD))
self.delete_by_article_ids([package.get(config.ID_FIELD)])
updates[LINKED_IN_PACKAGES] = [
package
for package in original.get(LINKED_IN_PACKAGES, [])
if package.get(PACKAGE_TYPE) != TAKES_PACKAGE
]
return
if self.__is_req_for_save(updates):
update_state(original, updates)
remove_unwanted(updates)
self._add_system_updates(original, updates, user)
self._add_desk_metadata(updates, original)
if original[ITEM_TYPE] == CONTENT_TYPE.PICTURE: # create crops
CropService().create_multiple_crops(updates, original)
# iterate over associations. Validate and process them if they are stored in database
if 'associations' in updates:
for item_name, item_obj in updates.get('associations').items():
if item_obj and config.ID_FIELD in item_obj:
_id = item_obj[config.ID_FIELD]
stored_item = self.find_one(req=None, _id=_id)
if stored_item:
self._validate_updates(stored_item, item_obj, user)
if stored_item[
ITEM_TYPE] == CONTENT_TYPE.PICTURE: # create crops
CropService().create_multiple_crops(
item_obj, stored_item)
stored_item.update(item_obj)
updates['associations'][item_name] = stored_item
def test_remove_media_files_for_picture_associations(self):
item = {
"_id": "testimage",
"type": "text",
"associations": {
"featuremedia": {
"_id": "123",
"renditions": self.media
},
"featurevideo": {
"_id": "456",
"renditions": {
"viewImage": {
"media": "testing_123",
"mimetype": "image/jpeg",
"href":
"http://192.168.220.209/api/upload/abc/raw?_schema=http",
"height": 452,
"width": 640,
},
"thumbnail": {
"media": "testing_456",
"mimetype": "image/jpeg",
"href":
"http://192.168.220.209/api/upload/abc/raw?_schema=http",
"height": 120,
"width": 169,
},
},
},
},
}
original = item.copy()
with patch.object(self.app.media, "delete") as media_delete:
CropService().update_media_references(item, original)
references_service = get_resource_service("media_references")
refs = references_service.get(req=None,
lookup={"item_id": "testimage"})
self.assertEqual(refs.count(), 6)
for ref in refs:
self.assertEqual(ref.get("published"), False)
CropService().update_media_references(item, original, True)
refs = references_service.get(req=None,
lookup={"item_id": "testimage"})
for ref in refs:
self.assertEqual(ref.get("published"), True)
remove_media_files(item)
self.assertEqual(0, media_delete.call_count)
def test_remove_media_files_for_picture_associations(self):
item = {
'_id': 'testimage',
'type': 'text',
'associations': {
'featuremedia': {
'_id': '123',
'renditions': self.media
},
'featurevideo': {
'_id': '456',
'renditions': {
'viewImage': {
'media': 'testing_123',
'mimetype': 'image/jpeg',
'href':
'http://192.168.220.209/api/upload/abc/raw?_schema=http',
'height': 452,
'width': 640
},
'thumbnail': {
'media': 'testing_456',
'mimetype': 'image/jpeg',
'href':
'http://192.168.220.209/api/upload/abc/raw?_schema=http',
'height': 120,
'width': 169
}
}
}
}
}
original = item.copy()
with patch.object(self.app.media, 'delete') as media_delete:
CropService().update_media_references(item, original)
references_service = get_resource_service('media_references')
refs = references_service.get(req=None,
lookup={'item_id': 'testimage'})
self.assertEqual(refs.count(), 6)
for ref in refs:
self.assertEqual(ref.get('published'), False)
CropService().update_media_references(item, original, True)
refs = references_service.get(req=None,
lookup={'item_id': 'testimage'})
for ref in refs:
self.assertEqual(ref.get('published'), True)
remove_media_files(item)
self.assertEqual(0, media_delete.call_count)
def _handle_media_updates(self, updates, original, user):
if original[ITEM_TYPE] == CONTENT_TYPE.PICTURE: # create crops
self.cropService.create_multiple_crops(updates, original)
if ASSOCIATIONS not in updates or not updates.get(ASSOCIATIONS):
return
# iterate over associations. Validate and process them if they are stored in database
for item_name, item_obj in updates.get(ASSOCIATIONS).items():
if not (item_obj and config.ID_FIELD in item_obj):
continue
if app.settings.get('COPY_METADATA_FROM_PARENT') and item_obj.get(
ITEM_TYPE) in MEDIA_TYPES:
stored_item = (original.get(ASSOCIATIONS)
or {}).get(item_name) or item_obj
else:
_id = item_obj[config.ID_FIELD]
stored_item = self.find_one(req=None, _id=_id)
if not stored_item:
continue
self._validate_updates(stored_item, item_obj, user)
if stored_item[ITEM_TYPE] == CONTENT_TYPE.PICTURE: # create crops
CropService().create_multiple_crops(item_obj, stored_item)
stored_item.update(item_obj)
updates[ASSOCIATIONS][item_name] = stored_item
def on_updated(self, updates, original):
original = get_resource_service(ARCHIVE).find_one(req=None, _id=original[config.ID_FIELD])
updates.update(original)
if updates[ITEM_OPERATION] != ITEM_KILL and \
original.get(ITEM_TYPE) in [CONTENT_TYPE.TEXT, CONTENT_TYPE.PREFORMATTED]:
get_resource_service('archive_broadcast').on_broadcast_master_updated(updates[ITEM_OPERATION], original)
get_resource_service('archive_broadcast').reset_broadcast_status(updates, original)
push_content_notification([updates])
self._import_into_legal_archive(updates)
CropService().update_media_references(updates, original, True)
superdesk.item_published.send(self, item=original)
packages = self.package_service.get_packages(original[config.ID_FIELD])
if packages and packages.count() > 0:
archive_correct = get_resource_service('archive_correct')
processed_packages = []
for package in packages:
original_updates = {'operation': updates['operation'], ITEM_STATE: updates[ITEM_STATE]}
if package[ITEM_STATE] in [CONTENT_STATE.PUBLISHED, CONTENT_STATE.CORRECTED] and \
package.get(PACKAGE_TYPE, '') == '' and \
str(package[config.ID_FIELD]) not in processed_packages:
original_updates['groups'] = package['groups']
if updates.get('headline'):
self.package_service.update_field_in_package(original_updates, original[config.ID_FIELD],
'headline', updates.get('headline'))
if updates.get('slugline'):
self.package_service.update_field_in_package(original_updates, original[config.ID_FIELD],
'slugline', updates.get('slugline'))
archive_correct.patch(id=package[config.ID_FIELD], updates=original_updates)
insert_into_versions(id_=package[config.ID_FIELD])
processed_packages.append(package[config.ID_FIELD])
def on_update(self, updates, original):
"""
Overridden to validate the updates to the article and take necessary actions depending on the updates. In brief,
it does the following:
1. Sets state, item operation, version created, version creator, sign off and word count.
2. Resets Item Expiry
3. If the request is to de-schedule then checks and de-schedules the associated Takes Package also.
4. Creates Crops if article is a picture
"""
user = get_user()
self._validate_updates(original, updates, user)
if 'publish_schedule' in updates and original[ITEM_STATE] == CONTENT_STATE.SCHEDULED:
self.deschedule_item(updates, original) # this is an deschedule action
# check if there is a takes package and deschedule the takes package.
package = TakesPackageService().get_take_package(original)
if package and package.get('state') == 'scheduled':
package_updates = {'publish_schedule': None, 'groups': package.get('groups')}
self.patch(package.get(config.ID_FIELD), package_updates)
return
if self.__is_req_for_save(updates):
update_state(original, updates)
remove_unwanted(updates)
self._add_system_updates(original, updates, user)
if original[ITEM_TYPE] == CONTENT_TYPE.PICTURE: # create crops
CropService().create_multiple_crops(updates, original)
def on_updated(self, updates, original):
get_component(ItemAutosave).clear(original['_id'])
if original[ITEM_TYPE] == CONTENT_TYPE.COMPOSITE:
self.packageService.on_updated(updates, original)
CropService().delete_replaced_crop_files(updates, original)
updated = copy(original)
updated.update(updates)
if config.VERSION in updates:
add_activity(
ACTIVITY_UPDATE,
'created new version {{ version }} for item {{ type }} about "{{ subject }}"',
self.datasource,
item=updated,
version=updates[config.VERSION],
subject=get_subject(updates, original),
type=updated[ITEM_TYPE])
push_content_notification([updated, original])
get_resource_service('archive_broadcast').reset_broadcast_status(
updates, original)
if updates.get('profile'):
get_resource_service('content_types').set_used(
[updates.get('profile')])
def on_update(self, updates, original):
CropService().validate_multiple_crops(updates, original)
super().on_update(updates, original)
updates[ITEM_OPERATION] = ITEM_CORRECT
updates['versioncreated'] = utcnow()
updates['correction_sequence'] = original.get('correction_sequence',
1) + 1
set_sign_off(updates, original)
def on_update(self, updates, original):
"""
Overridden to validate the updates to the article and take necessary actions depending on the updates. In brief,
it does the following:
1. Sets state, item operation, version created, version creator, sign off and word count.
2. Resets Item Expiry
3. If the request is to de-schedule then checks and de-schedules the associated Takes Package also.
4. Creates Crops if article is a picture
"""
user = get_user()
self._validate_updates(original, updates, user)
if PUBLISH_SCHEDULE in updates and original[
ITEM_STATE] == CONTENT_STATE.SCHEDULED:
self.deschedule_item(updates,
original) # this is an deschedule action
# check if there is a takes package and deschedule the takes package.
takes_service = TakesPackageService()
package = takes_service.get_take_package(original)
if package and package.get(ITEM_STATE) == CONTENT_STATE.SCHEDULED:
get_resource_service('published').delete_by_article_id(
package.get(config.ID_FIELD))
self.delete_by_article_ids([package.get(config.ID_FIELD)])
updates[LINKED_IN_PACKAGES] = [
package
for package in original.get(LINKED_IN_PACKAGES, [])
if package.get(PACKAGE_TYPE) != TAKES_PACKAGE
]
return
if self.__is_req_for_save(updates):
update_state(original, updates)
remove_unwanted(updates)
self._add_system_updates(original, updates, user)
self._add_desk_metadata(updates, original)
if original[ITEM_TYPE] == CONTENT_TYPE.PICTURE: # create crops
CropService().create_multiple_crops(updates, original)
updates_feature_image = updates.get('associations',
{}).get('featureimage')
if updates_feature_image and 'poi' in updates_feature_image:
original_feature_image = original.get('associations',
{}).get('featureimage', {})
if original_feature_image and original_feature_image.get(
'poi', {}) == updates_feature_image['poi']:
return
_id = updates_feature_image[config.ID_FIELD] if config.ID_FIELD in updates_feature_image \
else original_feature_image[config.ID_FIELD]
image_item = self.find_one(req=None, _id=_id)
if image_item:
image_item['poi'] = updates_feature_image['poi']
image_item = self.patch(_id, image_item)
updates['associations']['featureimage'][
'renditions'] = image_item['renditions']
def on_update(self, updates, original):
update_associations(updates)
CropService().validate_multiple_crops(updates, original)
super().on_update(updates, original)
updates[ITEM_OPERATION] = self.item_operation
updates['versioncreated'] = utcnow()
updates['correction_sequence'] = original.get('correction_sequence', 1) + 1
set_sign_off(updates, original)
update_word_count(updates, original)
def _handle_media_updates(self, updates, original, user):
update_associations(updates)
if original[ITEM_TYPE] == CONTENT_TYPE.PICTURE: # create crops
self.cropService.create_multiple_crops(updates, original)
if ASSOCIATIONS not in updates or not updates.get(ASSOCIATIONS):
return
body = updates.get("body_html", original.get("body_html", None))
# iterate over associations. Validate and process them if they are stored in database
for item_name, item_obj in updates.get(ASSOCIATIONS).items():
if not (item_obj and config.ID_FIELD in item_obj):
continue
item_id = item_obj[config.ID_FIELD]
media_item = {}
if app.settings.get('COPY_METADATA_FROM_PARENT') and item_obj.get(
ITEM_TYPE) in MEDIA_TYPES:
stored_item = (original.get(ASSOCIATIONS)
or {}).get(item_name) or item_obj
else:
media_item = stored_item = self.find_one(req=None, _id=item_id)
if not stored_item:
continue
self._validate_updates(stored_item, item_obj, user)
if stored_item[ITEM_TYPE] == CONTENT_TYPE.PICTURE: # create crops
CropService().create_multiple_crops(item_obj, stored_item)
if body and item_obj.get('description_text', None):
body = update_image_caption(body, item_name,
item_obj['description_text'])
# If the media item is not marked as 'used', mark it as used
if original.get(ITEM_TYPE) == CONTENT_TYPE.TEXT and \
(item_obj is not stored_item or not stored_item.get('used')):
if media_item is not stored_item:
media_item = self.find_one(req=None, _id=item_id)
if media_item and not media_item.get('used'):
self.system_update(media_item['_id'], {'used': True},
media_item)
stored_item['used'] = True
self._set_association_timestamps(item_obj, updates, new=False)
stored_item.update(item_obj)
if self._is_related_content(item_name):
updates[ASSOCIATIONS][item_name] = {'_id': item_id}
else:
updates[ASSOCIATIONS][item_name] = stored_item
if body:
updates["body_html"] = body
def on_update(self, updates, original):
CropService().validate_multiple_crops(updates, original)
super().on_update(updates, original)
updates[ITEM_OPERATION] = self.item_operation
updates["versioncreated"] = utcnow()
updates["correction_sequence"] = original.get("correction_sequence", 1) + 1
set_sign_off(updates, original)
update_word_count(updates, original)
flush_renditions(updates, original)
self.change_being_corrected_to_published(updates, original)
self.send_to_original_desk(updates, original)
def on_updated(self, updates, original):
original = super().find_one(req=None, _id=original[config.ID_FIELD])
updates.update(original)
if updates[ITEM_OPERATION] not in {ITEM_KILL, ITEM_TAKEDOWN
} and original.get(ITEM_TYPE) in [
CONTENT_TYPE.TEXT,
CONTENT_TYPE.PREFORMATTED,
]:
get_resource_service(
"archive_broadcast").on_broadcast_master_updated(
updates[ITEM_OPERATION], original)
get_resource_service("archive_broadcast").reset_broadcast_status(
updates, original)
push_content_notification([updates])
self._import_into_legal_archive(updates)
CropService().update_media_references(updates, original, True)
# Do not send item if it is scheduled, on real publishing send item to internal destination
if not updates.get(ITEM_STATE) == CONTENT_STATE.SCHEDULED:
signals.item_published.send(self, item=original)
packages = self.package_service.get_packages(original[config.ID_FIELD])
if packages and packages.count() > 0:
archive_correct = get_resource_service("archive_correct")
processed_packages = []
for package in packages:
original_updates = {
"operation": updates["operation"],
ITEM_STATE: updates[ITEM_STATE]
}
if (package[ITEM_STATE]
in [CONTENT_STATE.PUBLISHED, CONTENT_STATE.CORRECTED]
and package.get(PACKAGE_TYPE, "") == ""
and str(package[config.ID_FIELD])
not in processed_packages):
original_updates["groups"] = package["groups"]
if updates.get("headline"):
self.package_service.update_field_in_package(
original_updates, original[config.ID_FIELD],
"headline", updates.get("headline"))
if updates.get("slugline"):
self.package_service.update_field_in_package(
original_updates, original[config.ID_FIELD],
"slugline", updates.get("slugline"))
archive_correct.patch(id=package[config.ID_FIELD],
updates=original_updates)
insert_into_versions(id_=package[config.ID_FIELD])
processed_packages.append(package[config.ID_FIELD])
def on_updated(self, updates, original):
original = get_resource_service(ARCHIVE).find_one(req=None, _id=original[config.ID_FIELD])
updates.update(original)
if updates[ITEM_OPERATION] != ITEM_KILL and \
original.get(ITEM_TYPE) in [CONTENT_TYPE.TEXT, CONTENT_TYPE.PREFORMATTED]:
get_resource_service('archive_broadcast').on_broadcast_master_updated(updates[ITEM_OPERATION], original)
get_resource_service('archive_broadcast').reset_broadcast_status(updates, original)
push_content_notification([updates])
self._import_into_legal_archive(updates)
CropService().update_media_references(updates, original, True)
superdesk.item_published.send(self, item=original)
def on_updated(self, updates, original):
"""Runs on update
Locates the published or corrected non-take packages containing the corrected item
and corrects them
:param updates: correction
:param original: original story
"""
original_updates = dict()
original_updates['operation'] = updates['operation']
original_updates[ITEM_STATE] = updates[ITEM_STATE]
super().on_updated(updates, original)
CropService().delete_replaced_crop_files(updates, original)
packages = self.package_service.get_packages(original[config.ID_FIELD])
if packages and packages.count() > 0:
archive_correct = get_resource_service('archive_correct')
processed_packages = []
for package in packages:
if package[ITEM_STATE] in [CONTENT_STATE.PUBLISHED, CONTENT_STATE.CORRECTED] and \
package.get(PACKAGE_TYPE, '') == '' and \
str(package[config.ID_FIELD]) not in processed_packages:
original_updates['groups'] = package['groups']
if updates.get('headline'):
self.package_service.update_field_in_package(
original_updates, original[config.ID_FIELD],
'headline', updates.get('headline'))
if updates.get('slugline'):
self.package_service.update_field_in_package(
original_updates, original[config.ID_FIELD],
'slugline', updates.get('slugline'))
archive_correct.patch(id=package[config.ID_FIELD],
updates=original_updates)
insert_into_versions(id_=package[config.ID_FIELD])
processed_packages.append(package[config.ID_FIELD])
class ArchiveService(BaseService):
packageService = PackageService()
mediaService = ArchiveMediaService()
cropService = CropService()
def on_fetched(self, docs):
"""
Overriding this to handle existing data in Mongo & Elastic
"""
self.enhance_items(docs[config.ITEMS])
def on_fetched_item(self, doc):
self.enhance_items([doc])
def enhance_items(self, items):
for item in items:
handle_existing_data(item)
def on_create(self, docs):
on_create_item(docs)
for doc in docs:
if doc.get('body_footer') and is_normal_package(doc):
raise SuperdeskApiError.badRequestError(
"Package doesn't support Public Service Announcements")
self._test_readonly_stage(doc)
doc['version_creator'] = doc['original_creator']
remove_unwanted(doc)
update_word_count(doc)
set_item_expiry({}, doc)
if doc[ITEM_TYPE] == CONTENT_TYPE.COMPOSITE:
self.packageService.on_create([doc])
# Do the validation after Circular Reference check passes in Package Service
update_schedule_settings(doc, EMBARGO, doc.get(EMBARGO))
self.validate_embargo(doc)
update_associations(doc)
for assoc in doc.get(ASSOCIATIONS, {}).values():
self._set_association_timestamps(assoc, doc)
remove_unwanted(assoc)
if doc.get('media'):
self.mediaService.on_create([doc])
# let client create version 0 docs
if doc.get('version') == 0:
doc[config.VERSION] = doc['version']
self._add_desk_metadata(doc, {})
convert_task_attributes_to_objectId(doc)
def on_created(self, docs):
packages = [
doc for doc in docs if doc[ITEM_TYPE] == CONTENT_TYPE.COMPOSITE
]
if packages:
self.packageService.on_created(packages)
profiles = set()
for doc in docs:
subject = get_subject(doc)
if subject:
msg = 'added new {{ type }} item about "{{ subject }}"'
else:
msg = 'added new {{ type }} item with empty header/title'
add_activity(ACTIVITY_CREATE,
msg,
self.datasource,
item=doc,
type=doc[ITEM_TYPE],
subject=subject)
if doc.get('profile'):
profiles.add(doc['profile'])
self.cropService.update_media_references(doc, {})
if doc[ITEM_OPERATION] == ITEM_FETCH:
app.on_archive_item_updated({'task': doc.get('task')}, doc,
ITEM_FETCH)
else:
app.on_archive_item_updated({'task': doc.get('task')}, doc,
ITEM_CREATE)
get_resource_service('content_types').set_used(profiles)
push_content_notification(docs)
def on_update(self, updates, original):
"""Runs on archive update.
Overridden to validate the updates to the article and takes necessary actions depending on the updates.
In brief, it does the following:
1. Sets state, item operation, version created, version creator, sign off and word count.
2. Resets Item Expiry
3. Creates Crops if article is a picture
"""
user = get_user()
if ITEM_TYPE in updates:
del updates[ITEM_TYPE]
self._validate_updates(original, updates, user)
if self.__is_req_for_save(updates):
update_state(original, updates)
remove_unwanted(updates)
self._add_system_updates(original, updates, user)
self._add_desk_metadata(updates, original)
self._handle_media_updates(updates, original, user)
# send signal
superdesk.item_update.send(self, updates=updates, original=original)
def _handle_media_updates(self, updates, original, user):
update_associations(updates)
if original[ITEM_TYPE] == CONTENT_TYPE.PICTURE: # create crops
self.cropService.create_multiple_crops(updates, original)
if ASSOCIATIONS not in updates or not updates.get(ASSOCIATIONS):
return
body = updates.get("body_html", original.get("body_html", None))
# iterate over associations. Validate and process them if they are stored in database
for item_name, item_obj in updates.get(ASSOCIATIONS).items():
if not (item_obj and config.ID_FIELD in item_obj):
continue
item_id = item_obj[config.ID_FIELD]
media_item = {}
if app.settings.get('COPY_METADATA_FROM_PARENT') and item_obj.get(
ITEM_TYPE) in MEDIA_TYPES:
stored_item = (original.get(ASSOCIATIONS)
or {}).get(item_name) or item_obj
else:
media_item = stored_item = self.find_one(req=None, _id=item_id)
if not stored_item:
continue
self._validate_updates(stored_item, item_obj, user)
if stored_item[ITEM_TYPE] == CONTENT_TYPE.PICTURE: # create crops
CropService().create_multiple_crops(item_obj, stored_item)
if body and item_obj.get('description_text', None):
body = update_image_caption(body, item_name,
item_obj['description_text'])
# If the media item is not marked as 'used', mark it as used
if original.get(ITEM_TYPE) == CONTENT_TYPE.TEXT and \
(item_obj is not stored_item or not stored_item.get('used')):
if media_item is not stored_item:
media_item = self.find_one(req=None, _id=item_id)
if media_item and not media_item.get('used'):
self.system_update(media_item['_id'], {'used': True},
media_item)
stored_item['used'] = True
self._set_association_timestamps(item_obj, updates, new=False)
stored_item.update(item_obj)
updates[ASSOCIATIONS][item_name] = stored_item
if body:
updates["body_html"] = body
def on_updated(self, updates, original):
get_component(ItemAutosave).clear(original['_id'])
if original[ITEM_TYPE] == CONTENT_TYPE.COMPOSITE:
self.packageService.on_updated(updates, original)
updated = copy(original)
updated.update(updates)
if config.VERSION in updates:
add_activity(
ACTIVITY_UPDATE,
'created new version {{ version }} for item {{ type }} about "{{ subject }}"',
self.datasource,
item=updated,
version=updates[config.VERSION],
subject=get_subject(updates, original),
type=updated[ITEM_TYPE])
push_content_notification([updated, original])
get_resource_service('archive_broadcast').reset_broadcast_status(
updates, original)
if updates.get('profile'):
get_resource_service('content_types').set_used(
[updates.get('profile')])
self.cropService.update_media_references(updates, original)
def on_replace(self, document, original):
document[ITEM_OPERATION] = ITEM_UPDATE
remove_unwanted(document)
user = get_user()
lock_user = original.get('lock_user', None)
force_unlock = document.get('force_unlock', False)
user_id = str(user.get('_id'))
if lock_user and str(lock_user) != user_id and not force_unlock:
raise SuperdeskApiError.forbiddenError(
'The item was locked by another user')
document['versioncreated'] = utcnow()
set_item_expiry(document, original)
document['version_creator'] = user_id
if force_unlock:
del document['force_unlock']
def on_replaced(self, document, original):
get_component(ItemAutosave).clear(original['_id'])
add_activity(ACTIVITY_UPDATE,
'replaced item {{ type }} about {{ subject }}',
self.datasource,
item=original,
type=original['type'],
subject=get_subject(original))
push_content_notification([document, original])
self.cropService.update_media_references(document, original)
def on_deleted(self, doc):
get_component(ItemAutosave).clear(doc['_id'])
if doc[ITEM_TYPE] == CONTENT_TYPE.COMPOSITE:
self.packageService.on_deleted(doc)
remove_media_files(doc)
add_activity(ACTIVITY_DELETE,
'removed item {{ type }} about {{ subject }}',
self.datasource,
item=doc,
type=doc[ITEM_TYPE],
subject=get_subject(doc))
push_expired_notification([doc.get(config.ID_FIELD)])
app.on_archive_item_deleted(doc)
def replace(self, id, document, original):
return self.restore_version(id, document, original) or super().replace(
id, document, original)
def find_one(self, req, **lookup):
item = super().find_one(req, **lookup)
if item and str(item.get('task', {}).get('stage', '')) in \
get_resource_service('users').get_invisible_stages_ids(get_user().get('_id')):
raise SuperdeskApiError.forbiddenError(
"User does not have permissions to read the item.")
handle_existing_data(item)
return item
def restore_version(self, id, doc, original):
item_id = id
old_version = int(doc.get('old_version', 0))
last_version = int(doc.get('last_version', 0))
if (not all([item_id, old_version, last_version])):
return None
old = get_resource_service('archive_versions').find_one(
req=None, _id_document=item_id, _current_version=old_version)
if old is None:
raise SuperdeskApiError.notFoundError('Invalid version %s' %
old_version)
curr = get_resource_service(SOURCE).find_one(req=None, _id=item_id)
if curr is None:
raise SuperdeskApiError.notFoundError('Invalid item id %s' %
item_id)
if curr[config.VERSION] != last_version:
raise SuperdeskApiError.preconditionFailedError(
'Invalid last version %s' % last_version)
old['_id'] = old['_id_document']
old['_updated'] = old['versioncreated'] = utcnow()
set_item_expiry(old, doc)
old.pop('_id_document', None)
old.pop(SIGN_OFF, None)
old[ITEM_OPERATION] = ITEM_RESTORE
resolve_document_version(old, SOURCE, 'PATCH', curr)
remove_unwanted(old)
set_sign_off(updates=old, original=curr)
super().replace(id=item_id, document=old, original=curr)
old.pop('old_version', None)
old.pop('last_version', None)
doc.update(old)
return item_id
def duplicate_content(self, original_doc, state=None, extra_fields=None):
"""
Duplicates the 'original_doc' including it's version history. Copy and Duplicate actions use this method.
:return: guid of the duplicated article
"""
if original_doc.get(ITEM_TYPE, '') == CONTENT_TYPE.COMPOSITE:
for groups in original_doc.get('groups'):
if groups.get('id') != 'root':
associations = groups.get('refs', [])
for assoc in associations:
if assoc.get(RESIDREF):
item, _item_id, _endpoint = self.packageService.get_associated_item(
assoc)
assoc[RESIDREF] = assoc[
'guid'] = self.duplicate_content(item)
return self.duplicate_item(original_doc, state, extra_fields)
def duplicate_item(self,
original_doc,
state=None,
extra_fields=None,
operation=None):
"""Duplicates an item.
Duplicates the 'original_doc' including it's version history. If the article being duplicated is contained
in a desk then the article state is changed to Submitted.
:return: guid of the duplicated article
"""
new_doc = original_doc.copy()
self.remove_after_copy(new_doc, extra_fields)
on_duplicate_item(new_doc, original_doc, operation)
resolve_document_version(new_doc, SOURCE, 'PATCH', new_doc)
if original_doc.get('task',
{}).get('desk') is not None and new_doc.get(
ITEM_STATE) != CONTENT_STATE.SUBMITTED:
new_doc[ITEM_STATE] = CONTENT_STATE.SUBMITTED
if state:
new_doc[ITEM_STATE] = state
convert_task_attributes_to_objectId(new_doc)
get_model(ItemModel).create([new_doc])
self._duplicate_versions(original_doc['_id'], new_doc)
self._duplicate_history(original_doc['_id'], new_doc)
app.on_archive_item_updated({'duplicate_id': new_doc['guid']},
original_doc, operation or ITEM_DUPLICATE)
app.on_archive_item_updated({'duplicate_id': original_doc['_id']},
new_doc, operation or ITEM_DUPLICATED_FROM)
return new_doc['guid']
def remove_after_copy(self,
copied_item,
extra_fields=None,
delete_keys=None):
"""Removes the properties which doesn't make sense to have for an item after copy.
:param copied_item: item to copy
:param extra_fields: extra fields to copy besides content fields
"""
# get the archive schema keys
archive_schema_keys = list(
app.config['DOMAIN'][SOURCE]['schema'].keys())
archive_schema_keys.extend([
config.ID_FIELD, config.LAST_UPDATED, config.DATE_CREATED,
config.VERSION, config.ETAG
])
# Delete the keys that are not part of archive schema.
keys_to_delete = [
key for key in copied_item.keys() if key not in archive_schema_keys
]
keys_to_delete.extend([
config.ID_FIELD, 'guid', LINKED_IN_PACKAGES, EMBARGO,
PUBLISH_SCHEDULE, SCHEDULE_SETTINGS, 'lock_time', 'lock_action',
'lock_session', 'lock_user', SIGN_OFF, 'rewritten_by',
'rewrite_of', 'rewrite_sequence', 'highlights', 'marked_desks',
'_type', 'event_id', 'assignment_id', PROCESSED_FROM
])
if delete_keys:
keys_to_delete.extend(delete_keys)
if extra_fields:
keys_to_delete = [
key for key in keys_to_delete if key not in extra_fields
]
for key in keys_to_delete:
copied_item.pop(key, None)
# Copy should not preseve the SMS flag
if copied_item.get('flags', {}).get('marked_for_sms', False):
copied_item['flags']['marked_for_sms'] = False
task = copied_item.get('task', {})
task.pop(LAST_PRODUCTION_DESK, None)
task.pop(LAST_AUTHORING_DESK, None)
def _duplicate_versions(self, old_id, new_doc):
"""Duplicates versions for an item.
Duplicates the versions of the article identified by old_id. Each version identifiers are changed
to have the identifiers of new_doc.
:param old_id: identifier to fetch versions
:param new_doc: identifiers from this doc will be used to create versions for the duplicated item.
"""
resource_def = app.config['DOMAIN']['archive']
version_id = versioned_id_field(resource_def)
old_versions = get_resource_service('archive_versions').get(
req=None, lookup={version_id: old_id})
new_versions = []
for old_version in old_versions:
old_version[version_id] = new_doc[config.ID_FIELD]
del old_version[config.ID_FIELD]
old_version['guid'] = new_doc['guid']
old_version['unique_name'] = new_doc['unique_name']
old_version['unique_id'] = new_doc['unique_id']
old_version['versioncreated'] = utcnow()
if old_version[config.VERSION] == new_doc[config.VERSION]:
old_version[ITEM_OPERATION] = new_doc[ITEM_OPERATION]
new_versions.append(old_version)
last_version = deepcopy(new_doc)
last_version['_id_document'] = new_doc['_id']
del last_version['_id']
new_versions.append(last_version)
if new_versions:
get_resource_service('archive_versions').post(new_versions)
def _duplicate_history(self, old_id, new_doc):
"""Duplicates history for an item.
Duplicates the history of the article identified by old_id. Each history identifiers are changed
to have the identifiers of new_doc.
:param old_id: identifier to fetch history
:param new_doc: identifiers from this doc will be used to create version history for the duplicated item.
"""
old_history_items = get_resource_service('archive_history').get(
req=None, lookup={'item_id': old_id})
new_history_items = []
for old_history_item in old_history_items:
del old_history_item[config.ID_FIELD]
old_history_item['item_id'] = new_doc['guid']
if not old_history_item.get('original_item_id'):
old_history_item['original_item_id'] = old_id
new_history_items.append(old_history_item)
if new_history_items:
get_resource_service('archive_history').post(new_history_items)
def update(self, id, updates, original):
if updates.get(ASSOCIATIONS):
for association in updates[ASSOCIATIONS].values():
self._set_association_timestamps(association,
updates,
new=False)
remove_unwanted(association)
# this needs to here as resolve_nested_documents (in eve) will add the schedule_settings
if PUBLISH_SCHEDULE in updates and original[
ITEM_STATE] == CONTENT_STATE.SCHEDULED:
self.deschedule_item(updates,
original) # this is an deschedule action
return super().update(id, updates, original)
def deschedule_item(self, updates, original):
"""Deschedule an item.
This operation removed the item from publish queue and published collection.
:param dict updates: updates for the document
:param original: original is document.
"""
updates[ITEM_STATE] = CONTENT_STATE.PROGRESS
updates[PUBLISH_SCHEDULE] = original[PUBLISH_SCHEDULE]
updates[SCHEDULE_SETTINGS] = original[SCHEDULE_SETTINGS]
updates[ITEM_OPERATION] = ITEM_DESCHEDULE
# delete entry from published repo
get_resource_service('published').delete_by_article_id(original['_id'])
def can_edit(self, item, user_id):
"""
Determines if the user can edit the item or not.
"""
# TODO: modify this function when read only permissions for stages are implemented
# TODO: and Content state related checking.
if not current_user_has_privilege('archive'):
return False, 'User does not have sufficient permissions.'
item_location = item.get('task')
if item_location:
if item_location.get('desk'):
if not superdesk.get_resource_service('user_desks').is_member(
user_id, item_location.get('desk')):
return False, 'User is not a member of the desk.'
elif item_location.get('user'):
if not str(item_location.get('user')) == str(user_id):
return False, 'Item belongs to another user.'
return True, ''
def delete_by_article_ids(self, ids):
"""Remove the content
:param list ids: list of ids to be removed
"""
version_field = versioned_id_field(
app.config['DOMAIN']['archive_versions'])
get_resource_service('archive_versions').delete_action(
lookup={version_field: {
'$in': ids
}})
super().delete_action({config.ID_FIELD: {'$in': ids}})
def _set_association_timestamps(self, assoc_item, updates, new=True):
if type(assoc_item) == dict:
assoc_item[config.LAST_UPDATED] = updates.get(
config.LAST_UPDATED, datetime.datetime.now())
if new:
assoc_item[config.DATE_CREATED] = datetime.datetime.now()
elif config.DATE_CREATED in assoc_item:
del assoc_item[config.DATE_CREATED]
def __is_req_for_save(self, doc):
"""Checks if doc contains req_for_save key.
Patch of /api/archive is being used in multiple places. This method differentiates from the patch
triggered by user or not.
:param dictionary doc: doc to test
"""
if 'req_for_save' in doc:
req_for_save = doc['req_for_save']
del doc['req_for_save']
return req_for_save == 'true'
return True
def validate_embargo(self, item):
"""Validates the embargo of the item.
Following are checked:
1. Item can't be a package or a re-write of another story
2. Publish Schedule and Embargo are mutually exclusive
3. Always a future date except in case of Corrected and Killed.
:raises: SuperdeskApiError.badRequestError() if the validation fails
"""
if item[ITEM_TYPE] != CONTENT_TYPE.COMPOSITE:
if EMBARGO in item:
embargo = item.get(SCHEDULE_SETTINGS,
{}).get('utc_{}'.format(EMBARGO))
if embargo:
if item.get(PUBLISH_SCHEDULE) or item[
ITEM_STATE] == CONTENT_STATE.SCHEDULED:
raise SuperdeskApiError.badRequestError(
"An item can't have both Publish Schedule and Embargo"
)
if (item[ITEM_STATE] not in {
CONTENT_STATE.KILLED, CONTENT_STATE.RECALLED, CONTENT_STATE.SCHEDULED}) \
and embargo <= utcnow():
raise SuperdeskApiError.badRequestError(
"Embargo cannot be earlier than now")
if item.get('rewrite_of'):
raise SuperdeskApiError.badRequestError(
"Rewrites doesn't support Embargo")
if not isinstance(embargo,
datetime.date) or not embargo.time():
raise SuperdeskApiError.badRequestError(
"Invalid Embargo")
elif is_normal_package(item):
if item.get(EMBARGO):
raise SuperdeskApiError.badRequestError(
"A Package doesn't support Embargo")
self.packageService.check_if_any_item_in_package_has_embargo(item)
def _test_readonly_stage(self, item, updates=None):
"""If item is created or updated on readonly stage abort it.
:param item: edited/new item
:param updates: item updates
"""
def abort_if_readonly_stage(stage_id):
stage = superdesk.get_resource_service('stages').find_one(
req=None, _id=stage_id)
if stage.get('local_readonly'):
flask.abort(403, response={'readonly': True})
orig_stage_id = item.get('task', {}).get('stage')
if orig_stage_id and get_user() and not item.get(INGEST_ID):
abort_if_readonly_stage(orig_stage_id)
if updates:
dest_stage_id = updates.get('task', {}).get('stage')
if dest_stage_id and get_user() and not item.get(INGEST_ID):
abort_if_readonly_stage(dest_stage_id)
def _validate_updates(self, original, updates, user):
"""Validates updates to the article for the below conditions.
If any of these conditions are met then exception is raised:
1. Is article locked by another user other than the user requesting for update
2. Is state of the article is Killed or Recalled?
3. Is user trying to update the package with Public Service Announcements?
4. Is user authorized to update unique name of the article?
5. Is user trying to update the genre of a broadcast article?
6. Is article being scheduled and is in a package?
7. Is article being scheduled and schedule timestamp is invalid?
8. Does article has valid crops if the article type is a picture?
9. Is article a valid package if the article type is a package?
10. Does article has a valid Embargo?
11. Make sure that there are no duplicate anpa_category codes in the article.
12. Make sure there are no duplicate subjects in the upadte
13. Item is on readonly stage.
:raises:
SuperdeskApiError.forbiddenError()
- if state of the article is killed or user is not authorized to update unique name or if article is
locked by another user
SuperdeskApiError.badRequestError()
- if Public Service Announcements are being added to a package or genre is being updated for a
broadcast, is invalid for scheduling, the updates contain duplicate anpa_category or subject codes
"""
updated = original.copy()
updated.update(updates)
self._test_readonly_stage(original, updates)
lock_user = original.get('lock_user', None)
force_unlock = updates.get('force_unlock', False)
str_user_id = str(user.get(config.ID_FIELD)) if user else None
if lock_user and str(lock_user) != str_user_id and not force_unlock:
raise SuperdeskApiError.forbiddenError(
'The item was locked by another user')
if original.get(ITEM_STATE) in {
CONTENT_STATE.KILLED, CONTENT_STATE.RECALLED
}:
raise SuperdeskApiError.forbiddenError(
"Item isn't in a valid state to be updated.")
if updates.get('body_footer') and is_normal_package(original):
raise SuperdeskApiError.badRequestError(
"Package doesn't support Public Service Announcements")
if 'unique_name' in updates and not is_admin(user) \
and (user['active_privileges'].get('metadata_uniquename', 0) == 0) \
and not force_unlock:
raise SuperdeskApiError.forbiddenError(
"Unauthorized to modify Unique Name")
# if broadcast then update to genre is not allowed.
if original.get('broadcast') and updates.get('genre') and \
any(genre.get('qcode', '').lower() != BROADCAST_GENRE.lower() for genre in updates.get('genre')):
raise SuperdeskApiError.badRequestError(
'Cannot change the genre for broadcast content.')
if PUBLISH_SCHEDULE in updates or "schedule_settings" in updates:
if is_item_in_package(original) and not force_unlock:
raise SuperdeskApiError.badRequestError(
'This item is in a package and it needs to be removed before the item can be scheduled!'
)
update_schedule_settings(updated, PUBLISH_SCHEDULE,
updated.get(PUBLISH_SCHEDULE))
if updates.get(PUBLISH_SCHEDULE):
validate_schedule(
updated.get(SCHEDULE_SETTINGS,
{}).get('utc_{}'.format(PUBLISH_SCHEDULE)))
updates[SCHEDULE_SETTINGS] = updated.get(SCHEDULE_SETTINGS, {})
if original[ITEM_TYPE] == CONTENT_TYPE.PICTURE:
CropService().validate_multiple_crops(updates, original)
elif original[ITEM_TYPE] == CONTENT_TYPE.COMPOSITE:
self.packageService.on_update(updates, original)
# update the embargo date
update_schedule_settings(updated, EMBARGO, updated.get(EMBARGO))
# Do the validation after Circular Reference check passes in Package Service
self.validate_embargo(updated)
if EMBARGO in updates or "schedule_settings" in updates:
updates[SCHEDULE_SETTINGS] = updated.get(SCHEDULE_SETTINGS, {})
# Ensure that there are no duplicate categories in the update
category_qcodes = [
q['qcode'] for q in updates.get('anpa_category', []) or []
]
if category_qcodes and len(category_qcodes) != len(
set(category_qcodes)):
raise SuperdeskApiError.badRequestError(
"Duplicate category codes are not allowed")
# Ensure that there are no duplicate subjects in the update
subject_qcodes = [q['qcode'] for q in updates.get('subject', []) or []]
if subject_qcodes and len(subject_qcodes) != len(set(subject_qcodes)):
raise SuperdeskApiError.badRequestError(
"Duplicate subjects are not allowed")
def _add_system_updates(self, original, updates, user):
"""Adds system updates to item.
As the name suggests, this method adds properties which are derived based on updates sent in the request.
1. Sets item operation, version created, version creator, sign off and word count.
2. Resets Item Expiry
"""
convert_task_attributes_to_objectId(updates)
updates[ITEM_OPERATION] = ITEM_UPDATE
updates.setdefault('original_creator',
original.get('original_creator'))
updates['versioncreated'] = utcnow()
updates['version_creator'] = str(user.get(
config.ID_FIELD)) if user else None
update_word_count(updates, original)
update_version(updates, original)
set_item_expiry(updates, original)
set_sign_off(updates, original=original)
set_dateline(updates, original)
# Clear publish_schedule field
if updates.get(PUBLISH_SCHEDULE) \
and datetime.datetime.fromtimestamp(0).date() == updates.get(PUBLISH_SCHEDULE).date():
updates[PUBLISH_SCHEDULE] = None
updates[SCHEDULE_SETTINGS] = {}
if updates.get('force_unlock', False):
del updates['force_unlock']
def get_expired_items(self, expiry_datetime, invalid_only=False):
"""Get the expired items.
Where content state is not scheduled and the item matches given parameters
:param datetime expiry_datetime: expiry datetime
:param bool invalid_only: True only invalid items
:return pymongo.cursor: expired non published items.
"""
unique_id = 0
while True:
req = ParsedRequest()
req.sort = 'unique_id'
query = {
'$and': [{
'expiry': {
'$lte': date_to_str(expiry_datetime)
}
}, {
'$or': [{
'task.desk': {
'$ne': None
}
}, {
ITEM_STATE: CONTENT_STATE.SPIKED,
'task.desk': None
}]
}]
}
query['$and'].append({'unique_id': {'$gt': unique_id}})
if invalid_only:
query['$and'].append({'expiry_status': 'invalid'})
else:
query['$and'].append({'expiry_status': {'$ne': 'invalid'}})
req.where = json.dumps(query)
req.max_results = config.MAX_EXPIRY_QUERY_LIMIT
items = list(self.get_from_mongo(req=req, lookup=None))
if not len(items):
break
unique_id = items[-1]['unique_id']
yield items
def _add_desk_metadata(self, updates, original):
"""Populate updates metadata from item desk in case it's set.
It will only add data which is not set yet on the item.
:param updates: updates to item that should be saved
:param original: original item version before update
"""
return get_resource_service('desks').apply_desk_metadata(
updates, original)
def setUp(self):
self.service = CropService()
populate_table_json('vocabularies', [self.crop_sizes])
class CropTestCase(TestCase):
crop_sizes = {
"_id": "crop_sizes",
"display_name": "Image Crop Sizes",
"type": "manageable",
"items": [
{"is_active": True, "name": "4-3", "width": 800, "height": 600},
{"is_active": True, "name": "16-9", "width": 1280, "height": 720}
]
}
def setUp(self):
self.service = CropService()
populate_table_json('vocabularies', [self.crop_sizes])
def test_validate_aspect_ratio_fails(self):
doc = {'CropLeft': 0, 'CropRight': 80, 'CropTop': 0, 'CropBottom': 60}
crop = {'height': 700, 'width': 70}
with assert_raises(SuperdeskApiError):
self.service._validate_aspect_ratio(crop, doc)
def test_validate_aspect_ratio_fails_with_cropsize_less(self):
doc = {'CropLeft': 0, 'CropRight': 80, 'CropTop': 0, 'CropBottom': 60}
crop = {'height': 600, 'width': 800}
with assert_raises(SuperdeskApiError):
self.service._validate_aspect_ratio(crop, doc)
def test_validate_aspect_ratio_succeeds(self):
doc = {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
crop = {'height': 600, 'width': 800}
self.assertIsNone(self.service._validate_aspect_ratio(crop, doc))
def test_validate_aspect_ratio_succeeds_2(self):
doc = {'CropLeft': 0, 'CropRight': 1600, 'CropTop': 0, 'CropBottom': 1200}
crop = {'height': 600, 'width': 800}
self.assertIsNone(self.service._validate_aspect_ratio(crop, doc))
def test_get_crop_by_name(self):
self.assertIsNotNone(self.service.get_crop_by_name('16-9'))
self.assertIsNotNone(self.service.get_crop_by_name('4-3'))
self.assertIsNone(self.service.get_crop_by_name('d'))
def test_validate_crop_raises_error_if_item_is_not_picture(self):
original = {"type": "text"}
doc = {'renditions': {'4-3': {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}}}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, 'Only images can be cropped!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_renditions_are_missing(self):
original = {"type": "picture"}
doc = {'renditions': {'4-3': {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}}}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, 'Missing renditions!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_original_rendition_is_missing(self):
original = {"type": "picture",
"renditions": {"4-3": {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}}}
doc = {'renditions': {'4-3': {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}}}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, 'Missing original rendition!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_crop_name_is_unknown(self):
original = {"type": "picture",
"renditions": {
"original": {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
}
}
doc = {'renditions': {'d': {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}}}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "d")
ex = context.exception
self.assertEqual(ex.message, 'Unknown crop name! (name=d)')
self.assertEqual(ex.status_code, 400)
def test_add_crop_raises_error_if_original_missing(self):
original = {
'renditions': {
'4-3': {
}
}
}
doc = {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
with self.assertRaises(SuperdeskApiError) as context:
self.service.create_crop(original, '4-3', doc)
ex = context.exception
self.assertEqual(ex.message, 'Original file couldn\'t be found')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_converts_to_int(self):
crop = {'width': '300', 'height': 200}
self.service._validate_values(crop)
self.assertEqual(300, crop['width'])
self.assertEqual(200, crop['height'])
with self.assertRaises(SuperdeskApiError) as context:
self.service._validate_values({'width': 'foo'})
self.assertEqual(context.exception.message, 'Invalid value for width in renditions')
@mock.patch('superdesk.media.crop.crop_image', return_value=(False, 'test'))
def test_add_crop_raises_error(self, crop_name):
original = {
'renditions': {
'original': {
}
}
}
media = mock.MagicMock()
media.name = 'test.jpg'
with mock.patch('superdesk.app.media.get', return_value=media):
doc = {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
with self.assertRaises(SuperdeskApiError) as context:
self.service.create_crop(original, '4-3', doc)
ex = context.exception
self.assertEqual(ex.message, 'Saving crop failed.')
self.assertEqual(ex.status_code, 400)
def test_crop_image_exact_size(self):
img = get_picture_fixture()
size = {'width': '300', 'height': '200'}
crop = {'CropTop': '0', 'CropRight': '300', 'CropBottom': '200', 'CropLeft': '0'}
with open(img, 'rb') as imgfile:
res = crop_image(imgfile, img, crop, size)
self.assertTrue(res[0])
self.assertEqual(300, res[1].width)
self.assertEqual(200, res[1].height)
def test_resize_image(self):
img = get_picture_fixture()
with open(img, 'rb') as imgfile:
resized, width, height = _resize_image(imgfile, ('200', None), 'jpeg')
self.assertEqual(150, height)
def test_get_rendition_spec_no_custom_crop(self):
renditions = get_renditions_spec(no_custom_crops=True)
for crop in self.crop_sizes.get('items'):
self.assertNotIn(crop['name'], renditions)
def test_get_rendition_spec_with_custom_crop(self):
renditions = get_renditions_spec()
for crop in self.crop_sizes.get('items'):
self.assertIn(crop['name'], renditions)
def test_can_generate_custom_crop_from_original(self):
self.assertEquals(True, can_generate_custom_crop_from_original(800, 600, {'ratio': '16:9'}))
self.assertEquals(True, can_generate_custom_crop_from_original(800, 600, {'width': 800, 'height': 600}))
self.assertEquals(True, can_generate_custom_crop_from_original(810, 600, {'width': 800, 'height': 600}))
self.assertEquals(True, can_generate_custom_crop_from_original(810, 610, {'width': 800, 'height': 600}))
self.assertEquals(False, can_generate_custom_crop_from_original(780, 610, {'width': 800, 'height': 600}))
self.assertEquals(False, can_generate_custom_crop_from_original(780, 590, {'width': 800, 'height': 600}))
self.assertEquals(True, can_generate_custom_crop_from_original(780, 590, {'width': 800}))
self.assertEquals(True, can_generate_custom_crop_from_original(780, 590, {'height': 800}))
self.assertEquals(False, can_generate_custom_crop_from_original(780, 590, None))
def setUp(self):
super().setUp()
self.service = CropService()
populate_table_json('vocabularies', [self.crop_sizes])
class CropTestCase(TestCase):
crop_sizes = {
"_id":
"crop_sizes",
"display_name":
"Image Crop Sizes",
"type":
"manageable",
"items": [{
"is_active": True,
"name": "4-3",
"width": 800,
"height": 600
}, {
"is_active": True,
"name": "16-9",
"width": 1280,
"height": 720
}]
}
def setUp(self):
super().setUp()
self.service = CropService()
populate_table_json('vocabularies', [self.crop_sizes])
def test_validate_aspect_ratio_fails(self):
doc = {'CropLeft': 0, 'CropRight': 80, 'CropTop': 0, 'CropBottom': 60}
crop = {'height': 700, 'width': 70}
with assert_raises(SuperdeskApiError):
self.service._validate_aspect_ratio(crop, doc)
def test_validate_aspect_ratio_fails_with_cropsize_less(self):
doc = {'CropLeft': 0, 'CropRight': 80, 'CropTop': 0, 'CropBottom': 60}
crop = {'height': 600, 'width': 800}
with assert_raises(SuperdeskApiError):
self.service._validate_aspect_ratio(crop, doc)
def test_validate_aspect_ratio_succeeds(self):
doc = {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
crop = {'height': 600, 'width': 800}
self.assertIsNone(self.service._validate_aspect_ratio(crop, doc))
def test_validate_aspect_ratio_succeeds_2(self):
doc = {
'CropLeft': 0,
'CropRight': 1600,
'CropTop': 0,
'CropBottom': 1200
}
crop = {'height': 600, 'width': 800}
self.assertIsNone(self.service._validate_aspect_ratio(crop, doc))
def test_get_crop_by_name(self):
self.assertIsNotNone(self.service.get_crop_by_name('16-9'))
self.assertIsNotNone(self.service.get_crop_by_name('4-3'))
self.assertIsNone(self.service.get_crop_by_name('d'))
def test_validate_crop_raises_error_if_item_is_not_picture(self):
original = {"type": "text"}
doc = {
'renditions': {
'4-3': {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, 'Only images can be cropped!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_renditions_are_missing(self):
original = {"type": "picture"}
doc = {
'renditions': {
'4-3': {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, 'Missing renditions!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_original_rendition_is_missing(self):
original = {
"type": "picture",
"renditions": {
"4-3": {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
doc = {
'renditions': {
'4-3': {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, 'Missing original rendition!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_crop_name_is_unknown(self):
original = {
"type": "picture",
"renditions": {
"original": {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
doc = {
'renditions': {
'd': {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "d")
ex = context.exception
self.assertEqual(ex.message, 'Unknown crop name! (name=d)')
self.assertEqual(ex.status_code, 400)
def test_add_crop_raises_error_if_original_missing(self):
original = {'renditions': {'4-3': {}}}
doc = {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.create_crop(original, '4-3', doc)
ex = context.exception
self.assertEqual(ex.message, 'Original file couldn\'t be found')
self.assertEqual(ex.status_code, 400)
@mock.patch('superdesk.media.crop.crop_image',
return_value=(False, 'test'))
def test_add_crop_raises_error(self, crop_name):
original = {'renditions': {'original': {}}}
media = mock.MagicMock()
media.name = 'test.jpg'
with mock.patch('superdesk.app.media.get', return_value=media):
doc = {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.create_crop(original, '4-3', doc)
ex = context.exception
self.assertEqual(ex.message, 'Saving crop failed.')
self.assertEqual(ex.status_code, 400)
class CropTestCase(TestCase):
crop_sizes = {
"_id":
"crop_sizes",
"display_name":
"Image Crop Sizes",
"type":
"manageable",
"items": [
{
"is_active": True,
"name": "4-3",
"width": 800,
"height": 600
},
{
"is_active": True,
"name": "16-9",
"width": 1280,
"height": 720
},
],
}
def setUp(self):
self.service = CropService()
populate_table_json("vocabularies", [self.crop_sizes])
def test_validate_aspect_ratio_fails(self):
doc = {"CropLeft": 0, "CropRight": 80, "CropTop": 0, "CropBottom": 60}
crop = {"height": 700, "width": 70}
with assert_raises(SuperdeskApiError):
self.service._validate_aspect_ratio(crop, doc)
def test_validate_aspect_ratio_fails_with_cropsize_less(self):
doc = {"CropLeft": 0, "CropRight": 80, "CropTop": 0, "CropBottom": 60}
crop = {"height": 600, "width": 800}
with assert_raises(SuperdeskApiError):
self.service._validate_aspect_ratio(crop, doc)
def test_validate_aspect_ratio_succeeds(self):
doc = {
"CropLeft": 0,
"CropRight": 800,
"CropTop": 0,
"CropBottom": 600
}
crop = {"height": 600, "width": 800}
self.assertIsNone(self.service._validate_aspect_ratio(crop, doc))
def test_validate_aspect_ratio_succeeds_2(self):
doc = {
"CropLeft": 0,
"CropRight": 1600,
"CropTop": 0,
"CropBottom": 1200
}
crop = {"height": 600, "width": 800}
self.assertIsNone(self.service._validate_aspect_ratio(crop, doc))
def test_get_crop_by_name(self):
self.assertIsNotNone(self.service.get_crop_by_name("16-9"))
self.assertIsNotNone(self.service.get_crop_by_name("4-3"))
self.assertIsNone(self.service.get_crop_by_name("d"))
def test_validate_crop_raises_error_if_item_is_not_picture(self):
original = {"type": "text"}
doc = {
"renditions": {
"4-3": {
"CropLeft": 0,
"CropRight": 800,
"CropTop": 0,
"CropBottom": 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, "Only images can be cropped!")
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_renditions_are_missing(self):
original = {"type": "picture"}
doc = {
"renditions": {
"4-3": {
"CropLeft": 0,
"CropRight": 800,
"CropTop": 0,
"CropBottom": 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, "Missing renditions!")
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_original_rendition_is_missing(self):
original = {
"type": "picture",
"renditions": {
"4-3": {
"CropLeft": 0,
"CropRight": 800,
"CropTop": 0,
"CropBottom": 600
}
},
}
doc = {
"renditions": {
"4-3": {
"CropLeft": 0,
"CropRight": 800,
"CropTop": 0,
"CropBottom": 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, "Missing original rendition!")
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_crop_name_is_unknown(self):
original = {
"type": "picture",
"renditions": {
"original": {
"CropLeft": 0,
"CropRight": 800,
"CropTop": 0,
"CropBottom": 600
}
},
}
doc = {
"renditions": {
"d": {
"CropLeft": 0,
"CropRight": 800,
"CropTop": 0,
"CropBottom": 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "d")
ex = context.exception
self.assertEqual(ex.message, "Unknown crop name! (name=d)")
self.assertEqual(ex.status_code, 400)
def test_add_crop_raises_error_if_original_missing(self):
original = {"renditions": {"4-3": {}}}
doc = {
"CropLeft": 0,
"CropRight": 800,
"CropTop": 0,
"CropBottom": 600
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.create_crop(original, "4-3", doc)
ex = context.exception
self.assertEqual(ex.message, "Original file couldn't be found")
self.assertEqual(ex.status_code, 400)
def test_validate_crop_converts_to_int(self):
crop = {"width": "300", "height": 200}
self.service._validate_values(crop)
self.assertEqual(300, crop["width"])
self.assertEqual(200, crop["height"])
with self.assertRaises(SuperdeskApiError) as context:
self.service._validate_values({"width": "foo"})
self.assertEqual(context.exception.message,
"Invalid value for width in renditions")
@mock.patch("superdesk.media.crop.crop_image",
return_value=(False, "test"))
def test_add_crop_raises_error(self, crop_name):
original = {"renditions": {"original": {}}}
media = mock.MagicMock()
media.name = "test.jpg"
with mock.patch.object(self.app.media,
"fetch_rendition",
return_value=media):
doc = {
"CropLeft": 0,
"CropRight": 800,
"CropTop": 0,
"CropBottom": 600
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.create_crop(original, "4-3", doc)
ex = context.exception
self.assertEqual(ex.message, "Saving crop failed.")
self.assertEqual(ex.status_code, 400)
def test_crop_image_exact_size(self):
img = get_picture_fixture()
size = {"width": "300", "height": "200"}
crop = {
"CropTop": "0",
"CropRight": "300",
"CropBottom": "200",
"CropLeft": "0"
}
with open(img, "rb") as imgfile:
res = crop_image(imgfile, img, crop, size)
self.assertTrue(res[0])
self.assertEqual(300, res[1].width)
self.assertEqual(200, res[1].height)
def test_resize_image(self):
img = get_picture_fixture()
with open(img, "rb") as imgfile:
resized, width, height = _resize_image(imgfile, ("200", None),
"jpeg")
self.assertEqual(150, height)
def test_get_rendition_spec_no_custom_crop(self):
renditions = get_renditions_spec(no_custom_crops=True)
for crop in self.crop_sizes.get("items"):
self.assertNotIn(crop["name"], renditions)
def test_get_rendition_spec_with_custom_crop(self):
renditions = get_renditions_spec()
for crop in self.crop_sizes.get("items"):
self.assertIn(crop["name"], renditions)
def test_can_generate_custom_crop_from_original(self):
self.assertEquals(
True,
can_generate_custom_crop_from_original(800, 600,
{"ratio": "16:9"}))
self.assertEquals(
True,
can_generate_custom_crop_from_original(800, 600, {
"width": 800,
"height": 600
}))
self.assertEquals(
True,
can_generate_custom_crop_from_original(810, 600, {
"width": 800,
"height": 600
}))
self.assertEquals(
True,
can_generate_custom_crop_from_original(810, 610, {
"width": 800,
"height": 600
}))
self.assertEquals(
False,
can_generate_custom_crop_from_original(780, 610, {
"width": 800,
"height": 600
}))
self.assertEquals(
False,
can_generate_custom_crop_from_original(780, 590, {
"width": 800,
"height": 600
}))
self.assertEquals(
True,
can_generate_custom_crop_from_original(780, 590, {"width": 800}))
self.assertEquals(
True,
can_generate_custom_crop_from_original(780, 590, {"height": 800}))
self.assertEquals(
False, can_generate_custom_crop_from_original(780, 590, None))
def on_update(self, updates, original):
CropService().validate_multiple_crops(updates, original)
super().on_update(updates, original)
updates[ITEM_OPERATION] = ITEM_CORRECT
set_sign_off(updates, original)
def setUp(self):
super().setUp()
self.service = CropService()
populate_vocabularies([self.crop_sizes])
def setUp(self):
super().setUp()
self.service = CropService()
populate_vocabularies([self.crop_sizes])
class CropTestCase(TestCase):
crop_sizes = {
"_id":
"crop_sizes",
"display_name":
"Image Crop Sizes",
"type":
"manageable",
"items": [{
"is_active": True,
"name": "4-3",
"width": 800,
"height": 600
}, {
"is_active": True,
"name": "16-9",
"width": 1280,
"height": 720
}]
}
def setUp(self):
self.service = CropService()
populate_table_json('vocabularies', [self.crop_sizes])
def test_validate_aspect_ratio_fails(self):
doc = {'CropLeft': 0, 'CropRight': 80, 'CropTop': 0, 'CropBottom': 60}
crop = {'height': 700, 'width': 70}
with assert_raises(SuperdeskApiError):
self.service._validate_aspect_ratio(crop, doc)
def test_validate_aspect_ratio_fails_with_cropsize_less(self):
doc = {'CropLeft': 0, 'CropRight': 80, 'CropTop': 0, 'CropBottom': 60}
crop = {'height': 600, 'width': 800}
with assert_raises(SuperdeskApiError):
self.service._validate_aspect_ratio(crop, doc)
def test_validate_aspect_ratio_succeeds(self):
doc = {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
crop = {'height': 600, 'width': 800}
self.assertIsNone(self.service._validate_aspect_ratio(crop, doc))
def test_validate_aspect_ratio_succeeds_2(self):
doc = {
'CropLeft': 0,
'CropRight': 1600,
'CropTop': 0,
'CropBottom': 1200
}
crop = {'height': 600, 'width': 800}
self.assertIsNone(self.service._validate_aspect_ratio(crop, doc))
def test_get_crop_by_name(self):
self.assertIsNotNone(self.service.get_crop_by_name('16-9'))
self.assertIsNotNone(self.service.get_crop_by_name('4-3'))
self.assertIsNone(self.service.get_crop_by_name('d'))
def test_validate_crop_raises_error_if_item_is_not_picture(self):
original = {"type": "text"}
doc = {
'renditions': {
'4-3': {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, 'Only images can be cropped!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_renditions_are_missing(self):
original = {"type": "picture"}
doc = {
'renditions': {
'4-3': {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, 'Missing renditions!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_original_rendition_is_missing(self):
original = {
"type": "picture",
"renditions": {
"4-3": {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
doc = {
'renditions': {
'4-3': {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "4-3")
ex = context.exception
self.assertEqual(ex.message, 'Missing original rendition!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_crop_name_is_unknown(self):
original = {
"type": "picture",
"renditions": {
"original": {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
doc = {
'renditions': {
'd': {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
}
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, doc, "d")
ex = context.exception
self.assertEqual(ex.message, 'Unknown crop name! (name=d)')
self.assertEqual(ex.status_code, 400)
def test_add_crop_raises_error_if_original_missing(self):
original = {'renditions': {'4-3': {}}}
doc = {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.create_crop(original, '4-3', doc)
ex = context.exception
self.assertEqual(ex.message, 'Original file couldn\'t be found')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_converts_to_int(self):
crop = {'width': '300', 'height': 200}
self.service._validate_values(crop)
self.assertEqual(300, crop['width'])
self.assertEqual(200, crop['height'])
with self.assertRaises(SuperdeskApiError) as context:
self.service._validate_values({'width': 'foo'})
self.assertEqual(context.exception.message,
'Invalid value for width in renditions')
@mock.patch('superdesk.media.crop.crop_image',
return_value=(False, 'test'))
def test_add_crop_raises_error(self, crop_name):
original = {'renditions': {'original': {}}}
media = mock.MagicMock()
media.name = 'test.jpg'
with mock.patch('superdesk.app.media.get', return_value=media):
doc = {
'CropLeft': 0,
'CropRight': 800,
'CropTop': 0,
'CropBottom': 600
}
with self.assertRaises(SuperdeskApiError) as context:
self.service.create_crop(original, '4-3', doc)
ex = context.exception
self.assertEqual(ex.message, 'Saving crop failed.')
self.assertEqual(ex.status_code, 400)
def test_crop_image_exact_size(self):
img = get_picture_fixture()
size = {'width': '300', 'height': '200'}
crop = {
'CropTop': '0',
'CropRight': '300',
'CropBottom': '200',
'CropLeft': '0'
}
with open(img, 'rb') as imgfile:
res = crop_image(imgfile, img, crop, size)
self.assertTrue(res[0])
self.assertEqual(300, res[1].width)
self.assertEqual(200, res[1].height)
def test_resize_image(self):
img = get_picture_fixture()
with open(img, 'rb') as imgfile:
resized, width, height = _resize_image(imgfile, ('200', None),
'jpeg')
self.assertEqual(150, height)
def test_get_rendition_spec_no_custom_crop(self):
renditions = get_renditions_spec(no_custom_crops=True)
for crop in self.crop_sizes.get('items'):
self.assertNotIn(crop['name'], renditions)
def test_get_rendition_spec_with_custom_crop(self):
renditions = get_renditions_spec()
for crop in self.crop_sizes.get('items'):
self.assertIn(crop['name'], renditions)
def test_can_generate_custom_crop_from_original(self):
self.assertEquals(
True,
can_generate_custom_crop_from_original(800, 600,
{'ratio': '16:9'}))
self.assertEquals(
True,
can_generate_custom_crop_from_original(800, 600, {
'width': 800,
'height': 600
}))
self.assertEquals(
True,
can_generate_custom_crop_from_original(810, 600, {
'width': 800,
'height': 600
}))
self.assertEquals(
True,
can_generate_custom_crop_from_original(810, 610, {
'width': 800,
'height': 600
}))
self.assertEquals(
False,
can_generate_custom_crop_from_original(780, 610, {
'width': 800,
'height': 600
}))
self.assertEquals(
False,
can_generate_custom_crop_from_original(780, 590, {
'width': 800,
'height': 600
}))
self.assertEquals(
True,
can_generate_custom_crop_from_original(780, 590, {'width': 800}))
self.assertEquals(
True,
can_generate_custom_crop_from_original(780, 590, {'height': 800}))
self.assertEquals(
False, can_generate_custom_crop_from_original(780, 590, None))
def setUp(self):
self.service = CropService()
populate_table_json("vocabularies", [self.crop_sizes])
def _validate_updates(self, original, updates, user):
"""Validates updates to the article for the below conditions.
If any of these conditions are met then exception is raised:
1. Is article locked by another user other than the user requesting for update
2. Is state of the article is Killed or Recalled?
3. Is user trying to update the package with Public Service Announcements?
4. Is user authorized to update unique name of the article?
5. Is user trying to update the genre of a broadcast article?
6. Is article being scheduled and is in a package?
7. Is article being scheduled and schedule timestamp is invalid?
8. Does article has valid crops if the article type is a picture?
9. Is article a valid package if the article type is a package?
10. Does article has a valid Embargo?
11. Make sure that there are no duplicate anpa_category codes in the article.
12. Make sure there are no duplicate subjects in the upadte
13. Item is on readonly stage.
:raises:
SuperdeskApiError.forbiddenError()
- if state of the article is killed or user is not authorized to update unique name or if article is
locked by another user
SuperdeskApiError.badRequestError()
- if Public Service Announcements are being added to a package or genre is being updated for a
broadcast, is invalid for scheduling, the updates contain duplicate anpa_category or subject codes
"""
updated = original.copy()
updated.update(updates)
self._test_readonly_stage(original, updates)
lock_user = original.get('lock_user', None)
force_unlock = updates.get('force_unlock', False)
str_user_id = str(user.get(config.ID_FIELD)) if user else None
if lock_user and str(lock_user) != str_user_id and not force_unlock:
raise SuperdeskApiError.forbiddenError(
'The item was locked by another user')
if original.get(ITEM_STATE) in {
CONTENT_STATE.KILLED, CONTENT_STATE.RECALLED
}:
raise SuperdeskApiError.forbiddenError(
"Item isn't in a valid state to be updated.")
if updates.get('body_footer') and is_normal_package(original):
raise SuperdeskApiError.badRequestError(
"Package doesn't support Public Service Announcements")
if 'unique_name' in updates and not is_admin(user) \
and (user['active_privileges'].get('metadata_uniquename', 0) == 0) \
and not force_unlock:
raise SuperdeskApiError.forbiddenError(
"Unauthorized to modify Unique Name")
# if broadcast then update to genre is not allowed.
if original.get('broadcast') and updates.get('genre') and \
any(genre.get('qcode', '').lower() != BROADCAST_GENRE.lower() for genre in updates.get('genre')):
raise SuperdeskApiError.badRequestError(
'Cannot change the genre for broadcast content.')
if PUBLISH_SCHEDULE in updates or "schedule_settings" in updates:
if is_item_in_package(original) and not force_unlock:
raise SuperdeskApiError.badRequestError(
'This item is in a package and it needs to be removed before the item can be scheduled!'
)
update_schedule_settings(updated, PUBLISH_SCHEDULE,
updated.get(PUBLISH_SCHEDULE))
if updates.get(PUBLISH_SCHEDULE):
validate_schedule(
updated.get(SCHEDULE_SETTINGS,
{}).get('utc_{}'.format(PUBLISH_SCHEDULE)))
updates[SCHEDULE_SETTINGS] = updated.get(SCHEDULE_SETTINGS, {})
if original[ITEM_TYPE] == CONTENT_TYPE.PICTURE:
CropService().validate_multiple_crops(updates, original)
elif original[ITEM_TYPE] == CONTENT_TYPE.COMPOSITE:
self.packageService.on_update(updates, original)
# update the embargo date
update_schedule_settings(updated, EMBARGO, updated.get(EMBARGO))
# Do the validation after Circular Reference check passes in Package Service
self.validate_embargo(updated)
if EMBARGO in updates or "schedule_settings" in updates:
updates[SCHEDULE_SETTINGS] = updated.get(SCHEDULE_SETTINGS, {})
# Ensure that there are no duplicate categories in the update
category_qcodes = [
q['qcode'] for q in updates.get('anpa_category', []) or []
]
if category_qcodes and len(category_qcodes) != len(
set(category_qcodes)):
raise SuperdeskApiError.badRequestError(
"Duplicate category codes are not allowed")
# Ensure that there are no duplicate subjects in the update
subject_qcodes = [q['qcode'] for q in updates.get('subject', []) or []]
if subject_qcodes and len(subject_qcodes) != len(set(subject_qcodes)):
raise SuperdeskApiError.badRequestError(
"Duplicate subjects are not allowed")
class CropTestCase(TestCase):
crop_sizes = {
"_id": "crop_sizes",
"display_name": "Image Crop Sizes",
"type": "manageable",
"items": [
{"is_active": True, "name": "4-3", "width": 800, "height": 600},
{"is_active": True, "name": "16-9", "width": 1280, "height": 720}
]
}
def setUp(self):
super().setUp()
self.service = CropService()
populate_vocabularies([self.crop_sizes])
def test_validate_aspect_ratio_fails(self):
doc = {'CropLeft': 0, 'CropRight': 80, 'CropTop': 0, 'CropBottom': 60}
crop = {'height': 700, 'width': 70}
with assert_raises(SuperdeskApiError):
self.service._validate_aspect_ratio(crop, doc)
def test_validate_aspect_ratio_fails_with_cropsize_less(self):
doc = {'CropLeft': 0, 'CropRight': 80, 'CropTop': 0, 'CropBottom': 60}
crop = {'height': 600, 'width': 800}
with assert_raises(SuperdeskApiError):
self.service._validate_aspect_ratio(crop, doc)
def test_validate_aspect_ratio_succeeds(self):
doc = {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
crop = {'height': 600, 'width': 800}
self.assertIsNone(self.service._validate_aspect_ratio(crop, doc))
def test_validate_aspect_ratio_succeeds(self):
doc = {'CropLeft': 0, 'CropRight': 1600, 'CropTop': 0, 'CropBottom': 1200}
crop = {'height': 600, 'width': 800}
self.assertIsNone(self.service._validate_aspect_ratio(crop, doc))
def test_get_crop_by_name(self):
self.assertIsNotNone(self.service.get_crop_by_name('16-9'))
self.assertIsNotNone(self.service.get_crop_by_name('4-3'))
self.assertIsNone(self.service.get_crop_by_name('d'))
def test_validate_crop_raises_error_if_item_is_not_picture(self):
original = {"type": "text"}
doc = {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, "4-3", doc)
ex = context.exception
self.assertEqual(ex.message, 'Only images can be cropped!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_renditions_are_missing(self):
original = {"type": "picture"}
doc = {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, "4-3", doc)
ex = context.exception
self.assertEqual(ex.message, 'Missing renditions!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_original_rendition_is_missing(self):
original = {"type": "picture",
"renditions": {"4-3": {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}}}
doc = {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, "4-3", doc)
ex = context.exception
self.assertEqual(ex.message, 'Missing original rendition!')
self.assertEqual(ex.status_code, 400)
def test_validate_crop_raises_error_if_crop_name_is_unknown(self):
original = {"type": "picture",
"renditions": {
"original": {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
}
}
doc = {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
with self.assertRaises(SuperdeskApiError) as context:
self.service.validate_crop(original, "d", doc)
ex = context.exception
self.assertEqual(ex.message, 'Unknown crop name! (name=d)')
self.assertEqual(ex.status_code, 400)
def test_add_crop_raises_error_if_original_missing(self):
original = {
'renditions': {
'4-3': {
}
}
}
doc = {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
with self.assertRaises(SuperdeskApiError) as context:
self.service.create_crop(original, '4-3', doc)
ex = context.exception
self.assertEqual(ex.message, 'Original file couldn\'t be found')
self.assertEqual(ex.status_code, 400)
@mock.patch('superdesk.media.crop.crop_image', return_value=(False, 'test'))
def test_add_crop_raises_error(self, crop_name):
original = {
'renditions': {
'original': {
}
}
}
media = mock.MagicMock()
media.name = 'test.jpg'
with mock.patch('superdesk.app.media.get', return_value=media):
doc = {'CropLeft': 0, 'CropRight': 800, 'CropTop': 0, 'CropBottom': 600}
with self.assertRaises(SuperdeskApiError) as context:
self.service.create_crop(original, '4-3', doc)
ex = context.exception
self.assertEqual(ex.message, 'Saving crop failed.')
self.assertEqual(ex.status_code, 400)
def update(self, id, updates, original):
CropService().create_multiple_crops(updates, original)
super().update(id, updates, original)
