From d1c82313143b77249223d6da56823c51d1255137 Mon Sep 17 00:00:00 2001 From: "Sven R. Kunze" Date: Mon, 18 Jun 2012 23:34:15 +0200 Subject: [PATCH 01/20] Added route 'user/dashboard' and action 'dashboard' to user controller. --- ckan/config/routing.py | 1 + ckan/controllers/user.py | 13 +++++++++++++ 2 files changed, 14 insertions(+) diff --git a/ckan/config/routing.py b/ckan/config/routing.py index 3890032817f..b529d90eed7 100644 --- a/ckan/config/routing.py +++ b/ckan/config/routing.py @@ -252,6 +252,7 @@ def make_map(): m.connect('/user/edit', action='edit') # Note: openid users have slashes in their ids, so need the wildcard # in the route. + m.connect('/user/dashboard', action='dashboard') m.connect('/user/followers/{id:.*}', action='followers') m.connect('/user/edit/{id:.*}', action='edit') m.connect('/user/reset/{id:.*}', action='perform_reset') diff --git a/ckan/controllers/user.py b/ckan/controllers/user.py index c1b81dc3070..ebcfeaa9421 100644 --- a/ckan/controllers/user.py +++ b/ckan/controllers/user.py @@ -444,3 +444,16 @@ def followers(self, id=None): c.followers = get_action('user_follower_list')(context, {'id':c.user_dict['id']}) return render('user/followers.html') + + + def dashboard(self, id=None): + context = {'model': model, 'session': model.Session, + 'user': c.user or c.author, 'for_view': True} + data_dict = {'id':id, 'user_obj':c.userobj} + self._setup_template_variables(context, data_dict) + c.followers = get_action('user_follower_list')(context, + {'id':c.user_dict['id']}) + return render('user/followers.html') + + + From b26daa5cc74f9914de317012edd58d1d17283147 Mon Sep 17 00:00:00 2001 From: "Sven R. Kunze" Date: Tue, 19 Jun 2012 15:04:08 +0200 Subject: [PATCH 02/20] New template 'dashboard.html', modified layout --- ckan/controllers/user.py | 4 +--- ckan/templates/user/dashboard.html | 16 ++++++++++++++++ ckan/templates/user/layout.html | 1 + 3 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 ckan/templates/user/dashboard.html diff --git a/ckan/controllers/user.py b/ckan/controllers/user.py index ebcfeaa9421..ed967b781e7 100644 --- a/ckan/controllers/user.py +++ b/ckan/controllers/user.py @@ -451,9 +451,7 @@ def dashboard(self, id=None): 'user': c.user or c.author, 'for_view': True} data_dict = {'id':id, 'user_obj':c.userobj} self._setup_template_variables(context, data_dict) - c.followers = get_action('user_follower_list')(context, - {'id':c.user_dict['id']}) - return render('user/followers.html') + return render('user/dashboard.html') diff --git a/ckan/templates/user/dashboard.html b/ckan/templates/user/dashboard.html new file mode 100644 index 00000000000..139443aefca --- /dev/null +++ b/ckan/templates/user/dashboard.html @@ -0,0 +1,16 @@ + + + ${c.user} - Dashboard - User + + ${c.user_dict.display_name}'s Dashboard + + +
+ Hello World. +
+ + + diff --git a/ckan/templates/user/layout.html b/ckan/templates/user/layout.html index a61778d9d39..f0fbd5dcafd 100644 --- a/ckan/templates/user/layout.html +++ b/ckan/templates/user/layout.html @@ -8,6 +8,7 @@
    +
  • Dashboard
  • My Profile
  • Edit Profile
  • Log out
    • From 958d00408712c4a3c6b8bd535323ef7c140288de Mon Sep 17 00:00:00 2001 From: "Sven R. Kunze" Date: Wed, 20 Jun 2012 12:52:03 +0200 Subject: [PATCH 03/20] UserFollowingUser and UserFollowingDataset classes extended to discover followed users and datasets; inlcuded in user controller and template; contains bug: no datasets are displayed --- ckan/controllers/user.py | 4 +- ckan/logic/action/get.py | 55 +++++++++++++++++++++- ckan/model/follower.py | 74 +++++++++++++++++++++--------- ckan/templates/user/dashboard.html | 18 +++++++- 4 files changed, 126 insertions(+), 25 deletions(-) diff --git a/ckan/controllers/user.py b/ckan/controllers/user.py index ed967b781e7..e2a0060bf99 100644 --- a/ckan/controllers/user.py +++ b/ckan/controllers/user.py @@ -445,12 +445,14 @@ def followers(self, id=None): {'id':c.user_dict['id']}) return render('user/followers.html') - def dashboard(self, id=None): context = {'model': model, 'session': model.Session, 'user': c.user or c.author, 'for_view': True} data_dict = {'id':id, 'user_obj':c.userobj} self._setup_template_variables(context, data_dict) + c.followed_users = get_action('followed_user_list')(context, {'id':c.user_dict['id']}) + c.followed_datasets = get_action('followed_dataset_list')(context, {'id':c.user_dict['id']}) + return render('user/dashboard.html') diff --git a/ckan/logic/action/get.py b/ckan/logic/action/get.py index 191a72f7fea..8a98950b0d1 100644 --- a/ckan/logic/action/get.py +++ b/ckan/logic/action/get.py @@ -1869,7 +1869,7 @@ def _follower_list(context, data_dict, FollowerClass): users = [model.User.get(follower.follower_id) for follower in followers] users = [user for user in users if user is not None] - # Dictize the list of user objects. + # Dictize the list of User objects. return [model_dictize.user_dictize(user,context) for user in users] def user_follower_list(context, data_dict): @@ -1951,3 +1951,56 @@ def am_following_dataset(context, data_dict): return _am_following(context, data_dict, context['model'].UserFollowingDataset) + + +def followed_user_list(context, data_dict): + '''Return the list of users that are followed by the given user. + + :param id: the id or name of the user + :type id: string + :rtype: list of dictionaries + + ''' + schema = context.get('schema') or ( + ckan.logic.schema.default_follow_user_schema()) + data_dict, errors = _validate(data_dict, schema, context) + if errors: + raise ValidationError(errors, ckan.logic.action.error_summary(errors)) + + # Get the list of Follower objects. + model = context['model'] + user_id = data_dict.get('id') + followeds = model.UserFollowingUser.followed_list(user_id) + + # Convert the list of Follower objects to a list of User objects. + users = [model.User.get(followed.object_id) for followed in followeds] + users = [user for user in users if user is not None] + + # Dictize the list of User objects. + return [model_dictize.user_dictize(user, context) for user in users] + +def followed_dataset_list(context, data_dict): + '''Return the list of datasets that are followed by the given user. + + :param id: the id or name of the user + :type id: string + :rtype: list of dictionaries + + ''' + schema = context.get('schema') or ( + ckan.logic.schema.default_follow_user_schema()) + data_dict, errors = _validate(data_dict, schema, context) + if errors: + raise ValidationError(errors, ckan.logic.action.error_summary(errors)) + + # Get the list of Follower objects. + model = context['model'] + user_id = data_dict.get('id') + followeds = model.UserFollowingDataset.followed_list(user_id) + + # Convert the list of Follower objects to a list of Package objects. + packages = [model.Package.get(followed.object_id) for followed in followeds] + packages = [package for package in packages if package is not None] + + # Dictize the list of Package objects. + return [model_dictize.package_dictize(package, context) for package in packages] diff --git a/ckan/model/follower.py b/ckan/model/follower.py index 0698867682c..b270a964d2e 100644 --- a/ckan/model/follower.py +++ b/ckan/model/follower.py @@ -27,24 +27,39 @@ def get(self, follower_id, object_id): return query.first() @classmethod - def follower_count(cls, object_id): - '''Return the number of users following a user.''' + def is_following(cls, follower_id, object_id): + '''Return True if follower_id is currently following object_id, False + otherwise. + + ''' + return UserFollowingUser.get(follower_id, object_id) is not None + + + @classmethod + def followed_count(cls, follower_id): + '''Return the number of the users being followed by a user.''' return meta.Session.query(UserFollowingUser).filter( - UserFollowingUser.object_id == object_id).count() + UserFollowingUser.follower_id == follower_id).count() @classmethod - def follower_list(cls, object_id): - '''Return a list of all of the followers of a user.''' + def followed_list(cls, follower_id): + '''Return a list of the users being followed by a user.''' return meta.Session.query(UserFollowingUser).filter( - UserFollowingUser.object_id == object_id).all() + UserFollowingUser.follower_id == follower_id).all() + @classmethod - def is_following(cls, follower_id, object_id): - '''Return True if follower_id is currently following object_id, False - otherwise. + def follower_count(cls, user_id): + '''Return the number of the followers of a user.''' + return meta.Session.query(UserFollowingUser).filter( + UserFollowingUser.object_id == user_id).count() + + @classmethod + def follower_list(cls, user_id): + '''Return a list of the followers of a user.''' + return meta.Session.query(UserFollowingUser).filter( + UserFollowingUser.object_id == user_id).all() - ''' - return UserFollowingUser.get(follower_id, object_id) is not None user_following_user_table = sqlalchemy.Table('user_following_user', meta.metadata, @@ -85,24 +100,39 @@ def get(self, follower_id, object_id): return query.first() @classmethod - def follower_count(cls, object_id): - '''Return the number of users following a dataset.''' + def is_following(cls, follower_id, object_id): + '''Return True if follower_id is currently following object_id, False + otherwise. + + ''' + return UserFollowingDataset.get(follower_id, object_id) is not None + + + @classmethod + def followed_count(cls, follower_id): + '''Return the number of the datasets being followed by a user.''' return meta.Session.query(UserFollowingDataset).filter( - UserFollowingDataset.object_id == object_id).count() + UserFollowingDataset.follower_id == follower_id).count() @classmethod - def follower_list(cls, object_id): - '''Return a list of all of the followers of a dataset.''' + def followed_list(cls, follower_id): + '''Return a list of the datasets being followed by a user.''' return meta.Session.query(UserFollowingDataset).filter( - UserFollowingDataset.object_id == object_id).all() + UserFollowingDataset.follower_id == follower_id).all() + @classmethod - def is_following(cls, follower_id, object_id): - '''Return True if follower_id is currently following object_id, False - otherwise. + def follower_count(cls, dataset_id): + '''Return the number of the followers of a dataset.''' + return meta.Session.query(UserFollowingDataset).filter( + UserFollowingDataset.object_id == dataset_id).count() + + @classmethod + def follower_list(cls, dataset_id): + '''Return a list of the followers of a dataset.''' + return meta.Session.query(UserFollowingDataset).filter( + UserFollowingDataset.object_id == dataset_id).all() - ''' - return UserFollowingDataset.get(follower_id, object_id) is not None user_following_dataset_table = sqlalchemy.Table('user_following_dataset', meta.metadata, diff --git a/ckan/templates/user/dashboard.html b/ckan/templates/user/dashboard.html index 139443aefca..20681c9577f 100644 --- a/ckan/templates/user/dashboard.html +++ b/ckan/templates/user/dashboard.html @@ -8,8 +8,24 @@ ${c.user_dict.display_name}'s Dashboard +

    XXXX ${len(c.followed_users)} XXXX

    +

    XXXX ${len(c.followed_datasets)} XXXX

    +
    - Hello World. +
      +
    • +
        + ${h.linked_user(followed_user['name'], maxlength=20)} +
      +
      • +
    +
      +
    • +
        + ${h.dataset_link(followed_dataset['name'])} +
      +
      • +
    From 9b64dd9975ba30a3fdc0826801e7ea79a183bf1b Mon Sep 17 00:00:00 2001 From: "Sven R. Kunze" Date: Wed, 20 Jun 2012 16:19:07 +0200 Subject: [PATCH 04/20] Unified activity stream implemented unified means activities of the user, of the users being followed by the user and of the datasets being followed by the user --- ckan/controllers/user.py | 6 +--- ckan/logic/action/get.py | 52 +++++++++++++++++++++++++++++- ckan/model/activity.py | 4 +-- ckan/templates/user/dashboard.html | 41 ++++++++--------------- 4 files changed, 68 insertions(+), 35 deletions(-) diff --git a/ckan/controllers/user.py b/ckan/controllers/user.py index e2a0060bf99..0f63f8de1f8 100644 --- a/ckan/controllers/user.py +++ b/ckan/controllers/user.py @@ -450,10 +450,6 @@ def dashboard(self, id=None): 'user': c.user or c.author, 'for_view': True} data_dict = {'id':id, 'user_obj':c.userobj} self._setup_template_variables(context, data_dict) - c.followed_users = get_action('followed_user_list')(context, {'id':c.user_dict['id']}) - c.followed_datasets = get_action('followed_dataset_list')(context, {'id':c.user_dict['id']}) + c.dashboard_activity_stream = get_action('dashboard_activity_list_html')(context, {'id':c.user_dict['id']}) return render('user/dashboard.html') - - - diff --git a/ckan/logic/action/get.py b/ckan/logic/action/get.py index 8a98950b0d1..c8b0b796576 100644 --- a/ckan/logic/action/get.py +++ b/ckan/logic/action/get.py @@ -1834,6 +1834,7 @@ def user_follower_count(context, data_dict): :param id: the id or name of the user :type id: string + :rtype: int ''' @@ -1849,6 +1850,7 @@ def dataset_follower_count(context, data_dict): :param id: the id or name of the dataset :type id: string + :rtype: int ''' @@ -1877,6 +1879,7 @@ def user_follower_list(context, data_dict): :param id: the id or name of the user :type id: string + :rtype: list of dictionaries ''' @@ -1893,6 +1896,7 @@ def dataset_follower_list(context, data_dict): :param id: the id or name of the dataset :type id: string + :rtype: list of dictionaries ''' @@ -1923,6 +1927,7 @@ def am_following_user(context, data_dict): :param id: the id or name of the user :type id: string + :rtype: boolean ''' @@ -1940,6 +1945,7 @@ def am_following_dataset(context, data_dict): :param id: the id or name of the dataset :type id: string + :rtype: boolean ''' @@ -1952,12 +1958,12 @@ def am_following_dataset(context, data_dict): return _am_following(context, data_dict, context['model'].UserFollowingDataset) - def followed_user_list(context, data_dict): '''Return the list of users that are followed by the given user. :param id: the id or name of the user :type id: string + :rtype: list of dictionaries ''' @@ -1984,6 +1990,7 @@ def followed_dataset_list(context, data_dict): :param id: the id or name of the user :type id: string + :rtype: list of dictionaries ''' @@ -2004,3 +2011,46 @@ def followed_dataset_list(context, data_dict): # Dictize the list of Package objects. return [model_dictize.package_dictize(package, context) for package in packages] + +def dashboard_activity_list(context, data_dict): + '''Return the activity stream of the given user. + + :param id: the id or name of the user + :type id: string + + :rtype: list of dictionaries + + ''' + model = context['model'] + user_id = _get_or_bust(data_dict, 'id') + + activity_query = model.Session.query(model.Activity) + user_query = activity_query; + followed_users_query = activity_query.join(model.UserFollowingUser, model.UserFollowingUser.object_id == model.Activity.user_id) + followed_datasets_query = activity_query.join(model.UserFollowingDataset, model.UserFollowingDataset.object_id == model.Activity.object_id) + + user_query = user_query.filter(model.Activity.user_id==user_id) + followed_users_query = followed_users_query.filter(model.UserFollowingUser.follower_id==user_id) + followed_datasets_query = followed_datasets_query.filter(model.UserFollowingDataset.follower_id==user_id) + + query = user_query.union(followed_users_query).union(followed_datasets_query) + query = query.order_by(_desc(model.Activity.timestamp)) + query = query.limit(15) + activity_objects = query.all() + + return model_dictize.activity_list_dictize(activity_objects, context) + +def dashboard_activity_list_html(context, data_dict): + '''Return the dashboard activity stream of the given user as HTML. + + The activity stream is rendered as a snippet of HTML meant to be included + in an HTML page, i.e. it doesn't have any HTML header or footer. + + :param id: The id or name of the user. + :type id: string + + :rtype: string + + ''' + activity_stream = dashboard_activity_list(context, data_dict) + return _activity_list_to_html(context, activity_stream) diff --git a/ckan/model/activity.py b/ckan/model/activity.py index ff72337f04d..f4b6a7ef715 100644 --- a/ckan/model/activity.py +++ b/ckan/model/activity.py @@ -14,8 +14,8 @@ 'activity', meta.metadata, Column('id', types.UnicodeText, primary_key=True, default=_types.make_uuid), Column('timestamp', types.DateTime), - Column('user_id', types.UnicodeText), - Column('object_id', types.UnicodeText), + Column('user_id', types.UnicodeText, ForeignKey('user.id')), + Column('object_id', types.UnicodeText, ForeignKey('package.id')), Column('revision_id', types.UnicodeText), Column('activity_type', types.UnicodeText), Column('data', _types.JsonDictType), diff --git a/ckan/templates/user/dashboard.html b/ckan/templates/user/dashboard.html index 20681c9577f..74a2199707a 100644 --- a/ckan/templates/user/dashboard.html +++ b/ckan/templates/user/dashboard.html @@ -1,32 +1,19 @@ - - ${c.user} - Dashboard - User - - ${c.user_dict.display_name}'s Dashboard - + xmlns:i18n="http://genshi.edgewall.org/i18n" + xmlns:xi="http://www.w3.org/2001/XInclude" + py:strip=""> -

    XXXX ${len(c.followed_users)} XXXX

    -

    XXXX ${len(c.followed_datasets)} XXXX

    + ${c.user} - Dashboard - User + + ${c.user_dict.display_name}'s Dashboard + -
    -
      -
    • -
        - ${h.linked_user(followed_user['name'], maxlength=20)} -
      -
      • -
    -
      -
    • -
        - ${h.dataset_link(followed_dataset['name'])} -
      -
      • -
    -
    +
    +

    What's going on?

    +
    + ${c.dashboard_activity_stream} +
    +
    - + From 7fa53634b8163bc99f66d3c9ff4f2ecd0cae9899 Mon Sep 17 00:00:00 2001 From: "Sven R. Kunze" Date: Wed, 20 Jun 2012 16:53:40 +0200 Subject: [PATCH 05/20] Bug fixing, UI refinement --- ckan/lib/helpers.py | 2 +- ckan/public/css/style.css | 22 ++++++++++++++++++++++ ckan/templates/user/dashboard.html | 7 ++++++- 3 files changed, 29 insertions(+), 2 deletions(-) diff --git a/ckan/lib/helpers.py b/ckan/lib/helpers.py index 5b4fc60d01b..9ceba0f087e 100644 --- a/ckan/lib/helpers.py +++ b/ckan/lib/helpers.py @@ -506,7 +506,7 @@ def format_icon(_format): def linked_gravatar(email_hash, size=100, default=None): return literal( - '' % _('Update your avatar at gravatar.com') + '%s' % gravatar(email_hash,size,default) ) diff --git a/ckan/public/css/style.css b/ckan/public/css/style.css index 3d9758013ce..3812d6bd859 100644 --- a/ckan/public/css/style.css +++ b/ckan/public/css/style.css @@ -615,6 +615,28 @@ ul.userlist .badge { margin-top: 5px; } +/* ================== */ +/* = Dashboard page = */ +/* ================== */ + +.user.dashboard .page_heading { + font-weight: bold; +} + +.user.dashboard .page_heading img.gravatar { + padding: 2px; + border: solid 1px #ddd; + vertical-align: middle; + margin-right: 5px; + margin-top: -3px; +} + +.user.dashboard .page_heading .fullname { + font-weight: normal; + color: #999; +} + + /* ================== */ /* = User Read page = */ /* ================== */ diff --git a/ckan/templates/user/dashboard.html b/ckan/templates/user/dashboard.html index 74a2199707a..9c81af7a542 100644 --- a/ckan/templates/user/dashboard.html +++ b/ckan/templates/user/dashboard.html @@ -5,9 +5,14 @@ ${c.user} - Dashboard - User - ${c.user_dict.display_name}'s Dashboard + ${h.linked_gravatar(c.user_dict['email_hash'],48)} + ${c.user_dict['name']} + + (${c.user_dict['fullname']}) + +

    What's going on?

    From 7aef1cd36df8dcd10a093f533dbdd5781cf35261 Mon Sep 17 00:00:00 2001 From: "Sven R. Kunze" Date: Wed, 20 Jun 2012 17:53:40 +0200 Subject: [PATCH 06/20] Click on User tile redirects to dashboard --- ckan/templates/layout_base.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ckan/templates/layout_base.html b/ckan/templates/layout_base.html index 4ad1a19a0e9..a92f0d6b29e 100644 --- a/ckan/templates/layout_base.html +++ b/ckan/templates/layout_base.html @@ -52,7 +52,7 @@