def get(self, topic_id):
"""Returns the TopicRights object of a topic."""
topic_rights = topic_fetchers.get_topic_rights(topic_id, strict=False)
if topic_rights is None:
raise self.InvalidInputException(
'Expected a valid topic id to be provided.')
user_actions_info = user_services.UserActionsInfo(self.user_id)
can_edit_topic = topic_services.check_can_edit_topic(
user_actions_info, topic_rights)
can_publish_topic = (role_services.ACTION_CHANGE_TOPIC_STATUS
in user_actions_info.actions)
self.values.update({
'can_edit_topic': can_edit_topic,
'published': topic_rights.topic_is_published,
'can_publish_topic': can_publish_topic
})
self.render_json(self.values)
def unpublish_topic(topic_id, committer_id):
"""Marks the given topic as unpublished.
Args:
topic_id: str. The id of the given topic.
committer_id: str. ID of the committer.
Raises:
Exception. The given topic does not exist.
Exception. The topic is already unpublished.
Exception. The user does not have enough rights to unpublish the topic.
"""
topic_rights = topic_fetchers.get_topic_rights(topic_id, strict=False)
if topic_rights is None:
raise Exception('The given topic does not exist')
user = user_services.get_user_actions_info(committer_id)
if role_services.ACTION_CHANGE_TOPIC_STATUS not in user.actions:
raise Exception(
'The user does not have enough rights to unpublish the topic.')
if not topic_rights.topic_is_published:
raise Exception('The topic is already unpublished.')
topic_rights.topic_is_published = False
commit_cmds = [
topic_domain.TopicRightsChange(
{'cmd': topic_domain.CMD_UNPUBLISH_TOPIC})
]
save_topic_rights(topic_rights, committer_id, 'Unpublished the topic',
commit_cmds)
# Delete the exploration opportunities associated with the topic and reject
# the corresponding translation suggestions.
exp_ids = (
opportunity_services.
get_exploration_opportunity_ids_corresponding_to_topic(topic_id))
opportunity_services.delete_exploration_opportunities(exp_ids)
suggestion_services.auto_reject_translation_suggestions_for_exp_ids(
exp_ids)
def deassign_manager_role_from_topic(committer, user_id, topic_id):
"""Deassigns given user from all topics assigned to them.
Args:
committer: UserActionsInfo. UserActionsInfo object for the user
who is performing the action.
user_id: str. The ID of the user.
topic_id: str. The ID of the topic.
Raises:
Exception. The committer does not have rights to modify a role.
"""
topic_rights = topic_fetchers.get_topic_rights(topic_id)
if user_id not in topic_rights.manager_ids:
raise Exception('User does not have manager rights in topic.')
topic_rights.manager_ids.remove(user_id)
commit_cmds = [topic_domain.TopicRightsChange({
'cmd': topic_domain.CMD_REMOVE_MANAGER_ROLE,
'removed_user_id': user_id
})]
save_topic_rights(
topic_rights, committer.user_id,
'Removed all assigned topics from %s' % (user_id), commit_cmds)
def _save_topic(committer_id, topic, commit_message, change_list):
"""Validates a topic and commits it to persistent storage. If
successful, increments the version number of the incoming topic domain
object by 1.
Args:
committer_id: str. ID of the given committer.
topic: Topic. The topic domain object to be saved.
commit_message: str. The commit message.
change_list: list(TopicChange). List of changes applied to a topic.
Raises:
Exception. Received invalid change list.
Exception. The topic model and the incoming topic domain
object have different version numbers.
"""
if not change_list:
raise Exception(
'Unexpected error: received an invalid change list when trying to '
'save topic %s: %s' % (topic.id, change_list))
topic_rights = topic_fetchers.get_topic_rights(topic.id, strict=False)
topic.validate(strict=topic_rights.topic_is_published)
topic_model = topic_models.TopicModel.get(topic.id, strict=False)
# Topic model cannot be None as topic is passed as parameter here and that
# is only possible if a topic model with that topic id exists. Also this is
# a private function and so it cannot be called independently with any
# topic object.
if topic.version > topic_model.version:
raise Exception(
'Unexpected error: trying to update version %s of topic '
'from version %s. Please reload the page and try again.' %
(topic_model.version, topic.version))
elif topic.version < topic_model.version:
raise Exception(
'Trying to update version %s of topic from version %s, '
'which is too old. Please reload the page and try again.' %
(topic_model.version, topic.version))
topic_model.description = topic.description
topic_model.name = topic.name
topic_model.canonical_name = topic.canonical_name
topic_model.abbreviated_name = topic.abbreviated_name
topic_model.url_fragment = topic.url_fragment
topic_model.thumbnail_bg_color = topic.thumbnail_bg_color
topic_model.thumbnail_filename = topic.thumbnail_filename
topic_model.canonical_story_references = [
reference.to_dict() for reference in topic.canonical_story_references
]
topic_model.additional_story_references = [
reference.to_dict() for reference in topic.additional_story_references
]
topic_model.uncategorized_skill_ids = topic.uncategorized_skill_ids
topic_model.subtopics = [
subtopic.to_dict() for subtopic in topic.subtopics
]
topic_model.subtopic_schema_version = topic.subtopic_schema_version
topic_model.story_reference_schema_version = (
topic.story_reference_schema_version)
topic_model.next_subtopic_id = topic.next_subtopic_id
topic_model.language_code = topic.language_code
topic_model.meta_tag_content = topic.meta_tag_content
topic_model.practice_tab_is_displayed = topic.practice_tab_is_displayed
topic_model.page_title_fragment_for_web = topic.page_title_fragment_for_web
change_dicts = [change.to_dict() for change in change_list]
topic_model.commit(committer_id, commit_message, change_dicts)
caching_services.delete_multi(caching_services.CACHE_NAMESPACE_TOPIC, None,
[topic.id])
topic.version += 1
def assign_role(committer, assignee, new_role, topic_id):
"""Assigns a new role to the user.
Args:
committer: UserActionsInfo. UserActionsInfo object for the user
who is performing the action.
assignee: UserActionsInfo. UserActionsInfo object for the user
whose role is being changed.
new_role: str. The name of the new role. Possible values are:
ROLE_MANAGER.
topic_id: str. ID of the topic.
Raises:
Exception. The committer does not have rights to modify a role.
Exception. The assignee is already a manager for the topic.
Exception. The assignee doesn't have enough rights to become a manager.
Exception. The role is invalid.
"""
committer_id = committer.user_id
topic_rights = topic_fetchers.get_topic_rights(topic_id)
if (role_services.ACTION_MODIFY_CORE_ROLES_FOR_ANY_ACTIVITY
not in committer.actions):
logging.error('User %s tried to allow user %s to be a %s of topic %s '
'but was refused permission.' %
(committer_id, assignee.user_id, new_role, topic_id))
raise Exception(
'UnauthorizedUserException: Could not assign new role.')
assignee_username = user_services.get_username(assignee.user_id)
if role_services.ACTION_EDIT_OWNED_TOPIC not in assignee.actions:
raise Exception(
'The assignee doesn\'t have enough rights to become a manager.')
old_role = topic_domain.ROLE_NONE
if topic_rights.is_manager(assignee.user_id):
old_role = topic_domain.ROLE_MANAGER
if new_role == topic_domain.ROLE_MANAGER:
if topic_rights.is_manager(assignee.user_id):
raise Exception('This user already is a manager for this topic')
topic_rights.manager_ids.append(assignee.user_id)
elif new_role == topic_domain.ROLE_NONE:
if topic_rights.is_manager(assignee.user_id):
topic_rights.manager_ids.remove(assignee.user_id)
else:
old_role = topic_domain.ROLE_NONE
else:
raise Exception('Invalid role: %s' % new_role)
commit_message = rights_domain.ASSIGN_ROLE_COMMIT_MESSAGE_TEMPLATE % (
assignee_username, old_role, new_role)
commit_cmds = [
topic_domain.TopicRightsChange({
'cmd': topic_domain.CMD_CHANGE_ROLE,
'assignee_id': assignee.user_id,
'old_role': old_role,
'new_role': new_role
})
]
save_topic_rights(topic_rights, committer_id, commit_message, commit_cmds)
def post(self):
"""Generates structures for Android end-to-end tests.
This handler generates structures for Android end-to-end tests in
order to evaluate the integration of network requests from the
Android client to the backend. This handler should only be called
once (or otherwise raises an exception), and can only be used in
development mode (this handler is unavailable in production).
Note that the handler outputs an empty JSON dict when the request is
successful.
The specific structures that are generated:
Topic: A topic with both a test story and a subtopic.
Story: A story with 'android_interactions' as a exploration
node.
Exploration: 'android_interactions' from the local assets.
Subtopic: A dummy subtopic to validate the topic.
Skill: A dummy skill to validate the subtopic.
Raises:
Exception. When used in production mode.
InvalidInputException. The topic is already
created but not published.
InvalidInputException. The topic is already published.
"""
if not constants.DEV_MODE:
raise Exception('Cannot load new structures data in production.')
if topic_services.does_topic_with_name_exist('Android test'):
topic = topic_fetchers.get_topic_by_name('Android test')
topic_rights = topic_fetchers.get_topic_rights(topic.id,
strict=False)
if topic_rights.topic_is_published:
raise self.InvalidInputException(
'The topic is already published.')
raise self.InvalidInputException(
'The topic exists but is not published.')
exp_id = '26'
user_id = feconf.SYSTEM_COMMITTER_ID
# Generate new Structure id for topic, story, skill and question.
topic_id = topic_fetchers.get_new_topic_id()
story_id = story_services.get_new_story_id()
skill_id = skill_services.get_new_skill_id()
question_id = question_services.get_new_question_id()
# Create dummy skill and question.
skill = self._create_dummy_skill(skill_id, 'Dummy Skill for Android',
'<p>Dummy Explanation 1</p>')
question = self._create_dummy_question(question_id, 'Question 1',
[skill_id])
question_services.add_question(user_id, question)
question_services.create_new_question_skill_link(
user_id, question_id, skill_id, 0.3)
# Create and update topic to validate before publishing.
topic = topic_domain.Topic.create_default_topic(
topic_id, 'Android test', 'test-topic-one', 'description', 'fragm')
topic.update_url_fragment('test-topic')
topic.update_meta_tag_content('tag')
topic.update_page_title_fragment_for_web('page title for topic')
# Save the dummy image to the filesystem to be used as thumbnail.
with utils.open_file(os.path.join(feconf.TESTS_DATA_DIR,
'test_svg.svg'),
'rb',
encoding=None) as f:
raw_image = f.read()
fs = fs_services.GcsFileSystem(feconf.ENTITY_TYPE_TOPIC, topic_id)
fs.commit('%s/test_svg.svg' % (constants.ASSET_TYPE_THUMBNAIL),
raw_image,
mimetype='image/svg+xml')
# Update thumbnail properties.
topic_services.update_thumbnail_filename(topic, 'test_svg.svg')
topic.update_thumbnail_bg_color('#C6DCDA')
# Add other structures to the topic.
topic.add_canonical_story(story_id)
topic.add_uncategorized_skill_id(skill_id)
topic.add_subtopic(1, 'Test Subtopic Title', 'testsubtop')
# Update and validate subtopic.
topic_services.update_subtopic_thumbnail_filename(
topic, 1, 'test_svg.svg')
topic.update_subtopic_thumbnail_bg_color(1, '#FFFFFF')
topic.update_subtopic_url_fragment(1, 'suburl')
topic.move_skill_id_to_subtopic(None, 1, skill_id)
subtopic_page = (
subtopic_page_domain.SubtopicPage.create_default_subtopic_page(
1, topic_id))
# Upload local exploration to the datastore and enable feedback.
exp_services.load_demo(exp_id)
rights_manager.release_ownership_of_exploration(
user_services.get_system_user(), exp_id)
exp_services.update_exploration(
user_id, exp_id, [
exp_domain.ExplorationChange({
'cmd': exp_domain.CMD_EDIT_EXPLORATION_PROPERTY,
'property_name': 'correctness_feedback_enabled',
'new_value': True
})
], 'Changed correctness_feedback_enabled.')
# Add and update the exploration/node to the story.
story = story_domain.Story.create_default_story(
story_id, 'Android End to End testing', 'Description', topic_id,
'android-end-to-end-testing')
story.add_node('%s%d' % (story_domain.NODE_ID_PREFIX, 1),
'Testing with UI Automator')
story.update_node_description(
'%s%d' % (story_domain.NODE_ID_PREFIX, 1),
'To test all Android interactions')
story.update_node_exploration_id(
'%s%d' % (story_domain.NODE_ID_PREFIX, 1), exp_id)
# Save the dummy image to the filesystem to be used as thumbnail.
with utils.open_file(os.path.join(feconf.TESTS_DATA_DIR,
'test_svg.svg'),
'rb',
encoding=None) as f:
raw_image = f.read()
fs = fs_services.GcsFileSystem(feconf.ENTITY_TYPE_STORY, story_id)
fs.commit('%s/test_svg.svg' % (constants.ASSET_TYPE_THUMBNAIL),
raw_image,
mimetype='image/svg+xml')
story.update_node_thumbnail_filename(
'%s%d' % (story_domain.NODE_ID_PREFIX, 1), 'test_svg.svg')
story.update_node_thumbnail_bg_color(
'%s%d' % (story_domain.NODE_ID_PREFIX, 1), '#F8BF74')
# Update and validate the story.
story.update_meta_tag_content('tag')
story.update_thumbnail_filename('test_svg.svg')
story.update_thumbnail_bg_color(
constants.ALLOWED_THUMBNAIL_BG_COLORS['story'][0])
# Save the previously created structures
# (skill, story, topic, subtopic).
skill_services.save_new_skill(user_id, skill)
story_services.save_new_story(user_id, story)
topic_services.save_new_topic(user_id, topic)
subtopic_page_services.save_subtopic_page(
user_id, subtopic_page, 'Added subtopic', [
topic_domain.TopicChange({
'cmd': topic_domain.CMD_ADD_SUBTOPIC,
'subtopic_id': 1,
'title': 'Dummy Subtopic Title',
'url_fragment': 'dummy-fragment'
})
])
# Generates translation opportunities for the Contributor Dashboard.
exp_ids_in_story = story.story_contents.get_all_linked_exp_ids()
opportunity_services.add_new_exploration_opportunities(
story_id, exp_ids_in_story)
# Publish the story and topic.
topic_services.publish_story(topic_id, story_id, user_id)
topic_services.publish_topic(topic_id, user_id)
# Upload thumbnails to be accessible through AssetsDevHandler.
self._upload_thumbnail(topic_id, feconf.ENTITY_TYPE_TOPIC)
self._upload_thumbnail(story_id, feconf.ENTITY_TYPE_STORY)
self.render_json({})
def update_topic_and_subtopic_pages(
committer_id, topic_id, change_list, commit_message):
"""Updates a topic and its subtopic pages. Commits changes.
Args:
committer_id: str. The id of the user who is performing the update
action.
topic_id: str. The topic id.
change_list: list(TopicChange and SubtopicPageChange). These changes are
applied in sequence to produce the resulting topic.
commit_message: str or None. A description of changes made to the
topic.
Raises:
ValueError. Current user does not have enough rights to edit a topic.
"""
topic_rights = topic_fetchers.get_topic_rights(topic_id, strict=False)
if topic_rights.topic_is_published and not commit_message:
raise ValueError(
'Expected a commit message, received none.')
old_topic = topic_fetchers.get_topic_by_id(topic_id)
(
updated_topic, updated_subtopic_pages_dict,
deleted_subtopic_ids, newly_created_subtopic_ids,
updated_subtopic_pages_change_cmds_dict
) = apply_change_list(topic_id, change_list)
if (
old_topic.url_fragment != updated_topic.url_fragment and
does_topic_with_url_fragment_exist(updated_topic.url_fragment)):
raise utils.ValidationError(
'Topic with URL Fragment \'%s\' already exists'
% updated_topic.url_fragment)
if (
old_topic.name != updated_topic.name and
does_topic_with_name_exist(updated_topic.name)):
raise utils.ValidationError(
'Topic with name \'%s\' already exists' % updated_topic.name)
_save_topic(
committer_id, updated_topic, commit_message, change_list
)
# The following loop deletes those subtopic pages that are already in the
# datastore, which are supposed to be deleted in the current changelist.
for subtopic_id in deleted_subtopic_ids:
if subtopic_id not in newly_created_subtopic_ids:
subtopic_page_services.delete_subtopic_page(
committer_id, topic_id, subtopic_id)
for subtopic_page_id, subtopic_page in updated_subtopic_pages_dict.items():
subtopic_page_change_list = updated_subtopic_pages_change_cmds_dict[
subtopic_page_id]
subtopic_id = subtopic_page.get_subtopic_id_from_subtopic_page_id()
# The following condition prevents the creation of subtopic pages that
# were deleted above.
if subtopic_id not in deleted_subtopic_ids:
subtopic_page_services.save_subtopic_page(
committer_id, subtopic_page, commit_message,
subtopic_page_change_list)
generate_topic_summary(topic_id)
if old_topic.name != updated_topic.name:
opportunity_services.update_opportunities_with_new_topic_name(
updated_topic.id, updated_topic.name)
def test_get_topic_rights_is_none(self) -> None:
fake_topic_id = topic_fetchers.get_new_topic_id()
fake_topic: Optional[topic_domain.TopicRights] = (
topic_fetchers.get_topic_rights(fake_topic_id, strict=False))
self.assertIsNone(fake_topic)
def test_get_topic_rights_is_none(self):
fake_topic_id = topic_fetchers.get_new_topic_id()
fake_topic = topic_fetchers.get_topic_rights(
fake_topic_id, strict=False)
self.assertIsNone(fake_topic)
