def delete_story(committer_id, story_id, force_deletion=False):
"""Deletes the story with the given story_id.
Args:
committer_id: str. ID of the committer.
story_id: str. ID of the story to be deleted.
force_deletion: bool. If true, the story and its history are fully
deleted and are unrecoverable. Otherwise, the story and all
its history are marked as deleted, but the corresponding models are
still retained in the datastore. This last option is the preferred
one.
"""
story_model = story_models.StoryModel.get(story_id)
story = story_fetchers.get_story_from_model(story_model)
exp_ids = story.story_contents.get_all_linked_exp_ids()
story_model.delete(committer_id,
feconf.COMMIT_MESSAGE_STORY_DELETED,
force_deletion=force_deletion)
# This must come after the story is retrieved. Otherwise the memcache
# key will be reinstated.
story_memcache_key = story_fetchers.get_story_memcache_key(story_id)
memcache_services.delete(story_memcache_key)
# Delete the summary of the story (regardless of whether
# force_deletion is True or not).
delete_story_summary(story_id)
# Delete the opportunities available related to the exploration used in the
# story.
opportunity_services.delete_exploration_opportunities(exp_ids)
def _save_story(committer_id, story, commit_message, change_list):
"""Validates a story and commits it to persistent storage. If
successful, increments the version number of the incoming story domain
object by 1.
Args:
committer_id: str. ID of the given committer.
story: Story. The story domain object to be saved.
commit_message: str. The commit message.
change_list: list(StoryChange). List of changes applied to a story.
Raises:
ValidationError. An invalid exploration was referenced in the
story.
Exception. The story model and the incoming story domain
object have different version numbers.
"""
if not change_list:
raise Exception(
'Unexpected error: received an invalid change list when trying to '
'save story %s: %s' % (story.id, change_list))
topic = topic_fetchers.get_topic_by_id(story.corresponding_topic_id,
strict=False)
if topic is None:
raise utils.ValidationError(
'Expected story to only belong to a valid topic, but found no '
'topic with ID: %s' % story.corresponding_topic_id)
story_is_published = False
story_is_present_in_topic = False
for story_reference in topic.get_all_story_references():
if story_reference.story_id == story.id:
story_is_present_in_topic = True
story_is_published = story_reference.story_is_published
if not story_is_present_in_topic:
raise Exception(
'Expected story to belong to the topic %s, but it is '
'neither a part of the canonical stories or the additional '
'stories of the topic.' % story.corresponding_topic_id)
story.validate()
if story_is_published:
exp_ids = []
for node in story.story_contents.nodes:
if not node.exploration_id:
raise Exception('Story node with id %s does not contain an '
'exploration id.' % node.id)
exp_ids.append(node.exploration_id)
validate_explorations_for_story(exp_ids, True)
# Story model cannot be None as story is passed as parameter here and that
# is only possible if a story model with that story id exists. Also this is
# a private function and so it cannot be called independently with any
# story object.
story_model = story_models.StoryModel.get(story.id)
if story.version > story_model.version:
raise Exception(
'Unexpected error: trying to update version %s of story '
'from version %s. Please reload the page and try again.' %
(story_model.version, story.version))
elif story.version < story_model.version:
raise Exception(
'Trying to update version %s of story from version %s, '
'which is too old. Please reload the page and try again.' %
(story_model.version, story.version))
story_model.description = story.description
story_model.title = story.title
story_model.thumbnail_bg_color = story.thumbnail_bg_color
story_model.thumbnail_filename = story.thumbnail_filename
story_model.notes = story.notes
story_model.language_code = story.language_code
story_model.story_contents_schema_version = (
story.story_contents_schema_version)
story_model.story_contents = story.story_contents.to_dict()
story_model.corresponding_topic_id = story.corresponding_topic_id
story_model.version = story.version
change_dicts = [change.to_dict() for change in change_list]
story_model.commit(committer_id, commit_message, change_dicts)
memcache_services.delete(story_fetchers.get_story_memcache_key(story.id))
story.version += 1
def _save_story(committer_id, story, commit_message, change_list):
"""Validates a story and commits it to persistent storage. If
successful, increments the version number of the incoming story domain
object by 1.
Args:
committer_id: str. ID of the given committer.
story: Story. The story domain object to be saved.
commit_message: str. The commit message.
change_list: list(StoryChange). List of changes applied to a story.
Raises:
ValidationError: An invalid exploration was referenced in the
story.
Exception: The story model and the incoming story domain
object have different version numbers.
"""
if not change_list:
raise Exception(
'Unexpected error: received an invalid change list when trying to '
'save story %s: %s' % (story.id, change_list))
story.validate()
# Validate that all explorations referenced by the story exist.
exp_ids = []
for node in story.story_contents.nodes:
if node.exploration_id is not None:
exp_ids.append(node.exploration_id)
exp_summaries = (
exp_fetchers.get_exploration_summaries_matching_ids(exp_ids))
exp_summaries_dict = {
exp_id: exp_summaries[ind]
for (ind, exp_id) in enumerate(exp_ids)
}
for node in story.story_contents.nodes:
if (node.exploration_id
is not None) and (not exp_summaries_dict[node.exploration_id]):
raise utils.ValidationError(
'Expected story to only reference valid explorations, '
'but found an exploration with ID: %s (was it deleted?)' %
node.exploration_id)
# Story model cannot be None as story is passed as parameter here and that
# is only possible if a story model with that story id exists. Also this is
# a private function and so it cannot be called independently with any
# story object.
story_model = story_models.StoryModel.get(story.id)
if story.version > story_model.version:
raise Exception(
'Unexpected error: trying to update version %s of story '
'from version %s. Please reload the page and try again.' %
(story_model.version, story.version))
elif story.version < story_model.version:
raise Exception(
'Trying to update version %s of story from version %s, '
'which is too old. Please reload the page and try again.' %
(story_model.version, story.version))
topic = topic_fetchers.get_topic_by_id(story.corresponding_topic_id,
strict=False)
if topic is None:
raise utils.ValidationError(
'Expected story to only belong to a valid topic, but found an '
'topic with ID: %s' % story.corresponding_topic_id)
canonical_story_ids = topic.get_canonical_story_ids()
additional_story_ids = topic.get_additional_story_ids()
if story.id not in canonical_story_ids + additional_story_ids:
raise Exception(
'Expected story to belong to the topic %s, but it is '
'neither a part of the canonical stories or the additional stories '
'of the topic.' % story.corresponding_topic_id)
story_model.description = story.description
story_model.title = story.title
story_model.notes = story.notes
story_model.language_code = story.language_code
story_model.story_contents_schema_version = (
story.story_contents_schema_version)
story_model.story_contents = story.story_contents.to_dict()
story_model.corresponding_topic_id = story.corresponding_topic_id
story_model.version = story.version
change_dicts = [change.to_dict() for change in change_list]
story_model.commit(committer_id, commit_message, change_dicts)
memcache_services.delete(story_fetchers.get_story_memcache_key(story.id))
story.version += 1
def _save_story(committer_id, story, commit_message, change_list):
"""Validates a story and commits it to persistent storage. If
successful, increments the version number of the incoming story domain
object by 1.
Args:
committer_id: str. ID of the given committer.
story: Story. The story domain object to be saved.
commit_message: str. The commit message.
change_list: list(StoryChange). List of changes applied to a story.
Raises:
ValidationError: An invalid exploration was referenced in the
story.
Exception: The story model and the incoming story domain
object have different version numbers.
"""
if not change_list:
raise Exception(
'Unexpected error: received an invalid change list when trying to '
'save story %s: %s' % (story.id, change_list))
story.validate()
# Validate that all explorations referenced by the story exist.
exp_ids = [
node.exploration_id for node in story.story_contents.nodes
if node.exploration_id is not None]
# The first exp ID in the story to compare categories later on.
sample_exp_id = exp_ids[0] if exp_ids else None
# Strict = False, since the existence of explorations is checked below.
exps_dict = (
exp_fetchers.get_multiple_explorations_by_id(exp_ids, strict=False))
for node in story.story_contents.nodes:
if (node.exploration_id is not None) and (
node.exploration_id not in exps_dict):
raise utils.ValidationError(
'Expected story to only reference valid explorations, '
'but found an exploration with ID: %s (was it deleted?)' %
node.exploration_id)
if exps_dict:
common_exp_category = exps_dict[sample_exp_id].category
for exp_id in exps_dict:
exp = exps_dict[exp_id]
if exp.category != common_exp_category:
raise utils.ValidationError(
'All explorations in a story should be of the '
'same category. The explorations with ID %s and %s have'
' different categories.' % (sample_exp_id, exp_id))
if (
exp.language_code not in
android_validation_constants.SUPPORTED_LANGUAGES):
raise utils.ValidationError(
'Invalid language %s found for exploration with ID %s.'
% (exp.language_code, exp_id))
if exp.param_specs or exp.param_changes:
raise utils.ValidationError(
'Expected no exploration to have parameter values in'
' it. Invalid exploration: %s' % exp.id)
for state_name in exp.states:
state = exp.states[state_name]
if not state.interaction.is_supported_on_android_app():
raise utils.ValidationError(
'Invalid interaction %s in exploration with ID: %s.' %
(state.interaction.id, exp.id))
if not state.is_rte_content_supported_on_android():
raise utils.ValidationError(
'RTE content in state %s of exploration with ID %s is '
'not supported on mobile.' % (state_name, exp.id))
# Story model cannot be None as story is passed as parameter here and that
# is only possible if a story model with that story id exists. Also this is
# a private function and so it cannot be called independently with any
# story object.
story_model = story_models.StoryModel.get(story.id)
if story.version > story_model.version:
raise Exception(
'Unexpected error: trying to update version %s of story '
'from version %s. Please reload the page and try again.'
% (story_model.version, story.version))
elif story.version < story_model.version:
raise Exception(
'Trying to update version %s of story from version %s, '
'which is too old. Please reload the page and try again.'
% (story_model.version, story.version))
topic = topic_fetchers.get_topic_by_id(
story.corresponding_topic_id, strict=False)
if topic is None:
raise utils.ValidationError(
'Expected story to only belong to a valid topic, but found an '
'topic with ID: %s' % story.corresponding_topic_id)
canonical_story_ids = topic.get_canonical_story_ids()
additional_story_ids = topic.get_additional_story_ids()
if story.id not in canonical_story_ids + additional_story_ids:
raise Exception(
'Expected story to belong to the topic %s, but it is '
'neither a part of the canonical stories or the additional stories '
'of the topic.' % story.corresponding_topic_id)
story_model.description = story.description
story_model.title = story.title
story_model.notes = story.notes
story_model.language_code = story.language_code
story_model.story_contents_schema_version = (
story.story_contents_schema_version)
story_model.story_contents = story.story_contents.to_dict()
story_model.corresponding_topic_id = story.corresponding_topic_id
story_model.version = story.version
change_dicts = [change.to_dict() for change in change_list]
story_model.commit(committer_id, commit_message, change_dicts)
memcache_services.delete(story_fetchers.get_story_memcache_key(story.id))
story.version += 1
