details: http://www.bx.psu.edu/hg/galaxy/rev/6b66a5e142ab changeset: 2641:6b66a5e142ab user: jeremy goecks <jeremy.goecks@emory.edu> date: Fri Aug 28 15:27:01 2009 -0400 description: web controller to handle tagging (add/remove/autocomplete) 1 file(s) affected in this change: lib/galaxy/web/controllers/tag.py diffs (151 lines): diff -r b85cb0a65f46 -r 6b66a5e142ab lib/galaxy/web/controllers/tag.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/lib/galaxy/web/controllers/tag.py Fri Aug 28 15:27:01 2009 -0400 @@ -0,0 +1,147 @@ +""" +Tags Controller: handles tagging/untagging of entities and provides autocomplete support. +""" + +from galaxy.web.base.controller import * +from galaxy.tags.tag_handler import * +from sqlalchemy.sql.expression import func, and_ +from sqlalchemy.sql import select + +class TagsController ( BaseController ): + + def __init__(self, app): + BaseController.__init__(self, app) + + # Set up dict for mapping from short-hand to full item class. + self.shorthand_to_item_class_dict = dict() + self.shorthand_to_item_class_dict["history"] = History + self.shorthand_to_item_class_dict["hda"] = HistoryDatasetAssociation + + # Set up tag handler to recognize the following items: History, HistoryDatasetAssociation, ... + self.tag_handler = TagHandler() + self.tag_handler.add_tag_assoc_class(History, HistoryTagAssociation) + self.tag_handler.add_tag_assoc_class(HistoryDatasetAssociation, HistoryDatasetAssociationTagAssociation) + + @web.expose + def add_tag_async( self, trans, id=None, item_type=None, new_tag=None ): + """ Add tag to an item. """ + item = self._get_item(trans, item_type, trans.security.decode_id(id)) + + self._do_security_check(trans, item) + + self.tag_handler.apply_item_tags(trans.sa_session, item, new_tag) + trans.sa_session.flush() + + @web.expose + def remove_tag_async( self, trans, id=None, item_type=None, tag_name=None ): + """ Remove tag from an item. """ + item = self._get_item(trans, item_type, trans.security.decode_id(id)) + + self._do_security_check(trans, item) + + self.tag_handler.remove_item_tag(item, tag_name) + trans.sa_session.flush() + + # Retag an item. All previous tags are deleted and new tags are applied. + @web.expose + def retag_async( self, trans, id=None, item_type=None, new_tags=None ): + """ Apply a new set of tags to an item; previous tags are deleted. """ + item = self._get_item(trans, item_type, trans.security.decode_id(id)) + + self._do_security_check(trans, item) + + tag_handler.delete_item_tags(item) + self.tag_handler.apply_item_tags(trans.sa_session, item, new_tag) + trans.sa_session.flush() + + tag_handler.delete_item_tags(history) + tag_handler.apply_item_tags(trans.sa_session, history, new_tags) + # Flush to complete changes. + trans.sa_session.flush() + + @web.expose + @web.require_login( "get autocomplete data for an item's tags" ) + def tag_autocomplete_data(self, trans, id=None, item_type=None, q=None, limit=None, timestamp=None): + """ Get autocomplete data for an item's tags. """ + item = self._get_item(trans, item_type, trans.security.decode_id(id)) + + self._do_security_check(trans, item) + + # + # Get user's item tags and usage counts. + # + + # Get item-tag association class. + item_tag_assoc_class = self.tag_handler.get_tag_assoc_class(item.__class__) + + # Build select statement. + cols_to_select = [ item_tag_assoc_class.table.c.tag_id, item_tag_assoc_class.table.c.user_tname, item_tag_assoc_class.table.c.user_value, func.count('*') ] + from_obj = item_tag_assoc_class.table.join(item.table).join(Tag) + where_clause = self._get_column_for_filtering_item_by_user_id(item)==trans.get_user().id + order_by = [ func.count("*").desc() ] + ac_for_names = not q.endswith(":") + if ac_for_names: + # Autocomplete for tag names. + where_clause = and_(where_clause, Tag.table.c.name.like(q + "%")) + group_by = item_tag_assoc_class.table.c.tag_id + else: + # Autocomplete for tag values. + tag_name_and_value = q.split(":") + tag_name = tag_name_and_value[0] + tag_value = tag_name_and_value[1] + where_clause = and_(where_clause, Tag.table.c.name==tag_name) + where_clause = and_(where_clause, item_tag_assoc_class.table.c.value.like(tag_value + "%")) + group_by = item_tag_assoc_class.table.c.value + + # Do query and get result set. + query = select(columns=cols_to_select, from_obj=from_obj, + whereclause=where_clause, group_by=group_by, order_by=order_by) + result_set = trans.sa_session.execute(query) + + # Create and return autocomplete data. + if ac_for_names: + # Autocomplete for tag names. + ac_data = "#Header|Your Tags\n" + for row in result_set: + # Exclude tags that are already applied to the history. + if self.tag_handler.item_has_tag(item, row[1]): + continue + # Add tag to autocomplete data. + ac_data += row[1] + "|" + row[1] + "\n" + else: + # Autocomplete for tag values. + ac_data = "#Header|Your Values for '%s'\n" % (tag_name) + for row in result_set: + ac_data += tag_name + ":" + row[2] + "|" + row[2] + "\n" + + return ac_data + + def _get_column_for_filtering_item_by_user_id(self, item): + """ Returns the column to use when filtering by user id. """ + if isinstance(item, History): + return item.table.c.user_id + elif isinstance(item, HistoryDatasetAssociation): + # Use the user_id associated with the HDA's history. + history = item.history + return history.table.c.user_id + + def _get_item(self, trans, item_type, id): + """ Get an item based on type and id. """ + item_class = self.shorthand_to_item_class_dict[item_type] + item = trans.sa_session.query(item_class).filter("id=" + str(id))[0] + return item; + + def _do_security_check(self, trans, item): + """ Do security check on an item. """ + if isinstance(item, History): + history = item; + # Check that the history exists, and is either owned by the current + # user (if logged in) or the current history + assert history is not None + if history.user is None: + assert history == trans.get_history() + else: + assert history.user == trans.user + elif isinstance(item, HistoryDatasetAssociation): + # TODO. + pass