First round of changes to make plugin Melody-ready

CHANGES.md

@@ -0,0 +1,22 @@
+# Change Log for the User Profiles Plugin for Melody
+
+## 1.7
+
+*Status: not ready yet.*
+
+* Upgraded to use config.yaml.
+* Converted docs to markdown and added to distro.
+* Converted settings to config assistant.
+* Updated license to Artistic, and Copyright to Open Melody Software Group.
+
+## Movable Type Change Log
+
+* 1.63 - fix for callback not firing when save Extended Profile - Thanks to Chad Everett for reporting this one
+* 1.62 - fix for default Gravatar "G" icon being imported.
+* 1.61 - another fix for XML::Parser error
+* 1.6 - updated for MT 4.1, including migration to 4.1 "userpic" feature
+* 1.53 - skip author/comment URL generation if blog_id not set (solves error after upgrade on dashboard).
+* 1.52 - check for XML::Parser and skip those imports when not found, skip Profile build gracefully when no blog_id found
+* 1.51 - bug fix for attempted profile build during initial install
+* 1.5 - commenter upload of avatars + Pro version features
+* 1.0 - orginal release of free version

README.md

@@ -0,0 +1,152 @@
+User Profiles is a plugin for Melody that adds support for extensible public user profiles to a Melody powered blog or web site. This allows each user and commenter in your system to be given a dedicated URL on which you can display information about the contributions they have made, contributions like comments, entries and more. 
+
+# Features
+
+* Commenters can upload a profile image (any authenticated commenter, including Vox, OpenID, etc.)
+* Authenticated commenters can edit basic profile info
+* Authors and commenters have extended profiles.  Extended profiles come with 22 built-in fields (such as City, Country, Birthdate, About Me, etc.).
+* Custom fields for extended profiles can be defined by system administrators
+* Publish profile pages for each author and commenter, including profile images, basic and extended profile info, recent entries, and recent comments.
+* Automatically import profile images (avatars) for all your existing users from Gravatar, MyBlogLog, Vox, Livejournal, and BlogCatalog.
+* AJAX function auto-imports avatars in the background after new commenters login.
+
+# How it Works
+
+Authenticated commenters can edit their profiles and upload a profile image:
+
+<img src="/images/userprofiles_addimage_up.png" />
+
+Finally, the `<mt:AuthorImageURL>` and `<mt:CommenterImageURL>` tags can be used to display the user's profile image on your published blog pages (or use the core "userpic" tags in 4.1)
+
+Profile images are stored as *Assets* within Movable Type.  This means that these images can also be used in other ways, such as inserting them into entries.  Movable Type will keep the full size image (cropped to square, if necessary) and create thumbnails when using the tags described below.  Each profile image is tagged with '@userpic'.
+
+In addition, extended profiles can be edited, either from the admin interface, or by commenter via the "edit profile" link after they login.  User Profile pages are published automatically as static pages, which boosts performance for high traffic sites.
+
+# Template Tags
+
+## `<mt:AuthorImageURL>`
+
+This displays the url to a thumbnail of the author's profile image.  There is one optional argument:
+
+* *size* - the size in pixels of square thumbnail, default is 50 pixels (each side)
+
+## `<mt:IfAuthorImage>`
+
+This conditional tag displays its contents if the author has uploaded a profile image.
+
+## `<mt:AuthorImageURL>`
+
+This displays the url to a thumbnail of the commenter's profile image.  There is one optional argument:
+
+* *size* - the size in pixels of square thumbnail, default is 50 pixels (each side)
+
+## `<mt:IfCommenterImage>`
+
+This conditional tag displays its contents if the commenter has a profile image. 
+
+Note: if you posted a comment on your own blog (while signed in), your profile image will be displayed using this tag.
+
+**Example:**
+
+In your "Entry Metadata" template module, your could add the following:
+
+    <mt:IfAuthorImage>
+      <img src="<mt:AuthorImageURL size="50">" align="left" /> 
+    </mt:IfAuthorImage>
+
+This would display the author's profile image, *if* they have one in their profile.
+
+Similarly, in your "Comment Detail" module, you could add:
+
+    <mt:IfCommenterImage>
+      <img src="<mt:CommenterImageURL size="50">" align="left" />
+    </mt:IfCommenterImage>
+
+## `<mt:AuthorProfileURL>`
+
+This displays the url to the author's published profile page.
+
+## `<mt:CommenterProfileURL>`
+
+This displays the url to the commenter's published profile page.
+
+## `<mt:EntryAuthorLink>`
+
+This replaces the core tag of the same name.  Instead of linking to the author's URL, it will link to the author's profile page.
+
+## `<mt:CommentAuthorLink>`
+
+This replaces the core tag of the same name.  Instead of linking to the commenter's URL, it will link to the commenter's profile page.  If the commenter was not authenticated, it will link to the URL provided.
+
+## `<mt:UserProfile>`
+
+This tag is used to display extended profile information.  There is one required argument:
+
+* *field* - the name of the field that you wish to display.  For built-in fields, valid values are birthdate, first_name, last_name, address, city, state, country, mobile_phone, land_phone, sex, marital_status, occupation, company, signature, about_me, activities, interests, music, tv_shows, movies, books, or quotes. For custom-defined fields, use the defined name of the field (more on custom fields below).  Note that for the built-in "birthdate" field, you can also specify a "date_format" argument that follows MT's date formats.
+
+## `<mt:AuthorComments>`
+
+This container tag, which is used on the default "User Profile" template, displays the comments from the author in context.  On the published User Profile page, this is used to display a list of recent comments by the user.
+
+# Default Profile Templates
+
+User Profiles comes with several default templates that are easy to install with the <a href="http://mt-hacks.com/templateinstaller.html">Template Installer</a> plugin.  The User Profile template set includes the following templates:
+
+* **Javascript** - This a replacement for the core "Javascript" index template.  If you have customized your existing template, it will be backed up during the installation process.  The new version includes some new features for User Profiles.
+
+* **Edit User Profile** - This template module is used to display the "edit profile" page that commenter's see when they click the "Edit Profile" link.  Note that this template also displays the image upload and the "edit extended profile" pages.  You can customize the user profile experience (and extended profile fields) bu editing this module.  Note: you should not rename this template module.
+
+* **User Profile** (Pro only) - This template module is used to publish the User Profile pages.  Customize this template to change the way user profiles are displayed.  A special note about this template -- when you save it, it will automatically republish all user profile pages (no need to republish your site). Note: you should not rename this template module.
+
+* **YUI Javascript** (Pro only) - This template module includes reference links to several Yahoo Javascript libraries.  This template should be included in the Header template for all feedback templates (Entry archives).  The auto-image-import AJAX function uses these libraries.  Note:  if you are already using the <a href="http://mt-hacks.com/ajaxcomments.html">Ajax Comments</a> plugin, then you already have this module, so you don't need to include it again.
+
+# Requirements
+
+* Melody 1.0 or greater
+* Image::Magick perl module
+
+# Installation
+
+1. Download the zip file and upload the contents of the 'plugins' folder to the 'plugins' directory of your MT installation.
+
+2. You should now see an Upgrade Screen for User Profiles.  For User Profiles Pro, the upgrade will add a new table for extended profiles and import profile images for existing users in your system.
+
+3. Go to System Overview, then to Preferences > Plugins.  Then choose User Profiles, then Settings.  Entry the blog_id for profile images and templates, and the path for uploading profile images, then save.
+
+4. Return to the User Profiles settings and click the "Install Templates" button.  The templates will be installed into the blog you chose in the previous step.
+
+5. In your "Header" template, add the following before the &lt;/head> tag:
+
+        <mt:If name="include_javascript">
+          <script type="text/javascript" src="<mt:Link template="javascript">"></script>
+        </mt:If>
+
+    And (Pro only) after the line that reads `<mt:If name="entry_template">`, add:
+
+        <mt:Include module="YUI Javascript">
+
+    Then save your "Header" template.
+
+6. Republish your Javascript template and Entry archives for the chosen blog.
+
+7. Upload a profile image from your profile. (Tip: the quickest way to get to your profile is to click the "Hi Username!" link in the very top right of the page.)  Click the link to add a profile image and follow the steps as shown above.
+
+8. Edit your extended profile by clicking "Extended Profile" from your profile page.
+
+9. Edit your templates to display profile images, as described in the Template Tags section above.
+
+# Customizing Extended Profiles and Adding Custom Fields
+
+User of User Profiles Pro may want to customized the display of the fields or add custom fields to the profiles.  <a href="http://mt-hacks.com/20071201-customizing-extended-user-profile-fields.html" target="_blank">Click to read an in-depth article on how to customize Extended Profiles</a>.
+
+# License
+
+The User Profile plugin for Melody is licensed under the same terms as Perl itself. 
+
+# Copyright
+
+Copyright 2011, The Open Melody Software Group. All rights reserved.
+
+# Acknowledgements 
+
+The User Profiles Plugin was created and made possible by the fine work of Mark Carey, who kindly donated his work to the Open Melody Software Group and to the Melody community at large. Thank you Mark.

addons/UserProfiles.plugin/config.yaml

@@ -0,0 +1,109 @@
+name: User Profiles
+id: UserProfiles
+key: UserProfiles
+author_link: 'http://mt-hacks.com/'
+author_name: 'Mark Carey'
+description: "Adds support for user profiles on Melody blogs."
+doc_link: "http://mt-hacks.com/userprofiles.html",
+version: 1.7
+schema_version: 17
+
+object_types:
+  author:
+    profile_asset_id: integer meta
+  profile: 'UserProfiles::Pro::Object::Profile'
+
+default_templates:
+  base_path: templates
+  global:system:
+    edit_user_profile:
+      label: Edit User Profile
+    user_profile:
+      label: User Profile
+  global:module:
+    yui_javascript:
+      label: YUI Javascript
+
+#	system_config_template => 'system_settings.tmpl',
+#	settings => new MT::PluginSettings([
+#        ['profile_upload_path', { Default => '' }],
+#        ['profile_blog_id', { Default => '' }],
+#        ]),
+
+applications:
+  cms: 
+    methods:
+      install_userprofiles_templates: $UserProfiles::UserProfiles::App::CMS::install_templates
+      edit_userprofile: $UserProfiles::UserProfiles::Pro::App::CMS::cms_edit_userprofile
+      save_userprofile: $UserProfiles::UserProfiles::Pro::App::CMS::cms_save_userprofile
+#      userprofiles_start_image: '$UserProfiles::UserProfiles::App::CMS::start_image
+#	   save_profile_image: '$UserProfiles::UserProfiles::App::CMS::save_profile_image
+#	   remove_profile_image: '$UserProfiles::UserProfiles::App::CMS::remove_profile_image
+  userprofiles:
+    handler: 'UserProfiles::App'
+    methods:
+      edit_userprofile: $UserProfiles::UserProfiles::App::UserProfiles::edit_userprofile
+      save_userprofile: $UserProfiles::UserProfiles::App::UserProfiles::save_userprofile
+      start_image: $UserProfiles::UserProfiles::App::UserProfiles::start_image
+      add_image: $UserProfiles::UserProfiles::App::UserProfiles::add_image
+      save_image: $UserProfiles::UserProfiles::App::UserProfiles::save_image
+      remove_image: $UserProfiles::UserProfiles::App::UserProfiles::remove_image
+      save_extendedprofile: $UserProfiles::UserProfiles::Pro::App::UserProfiles::save_extendedprofile
+      get_image: $UserProfiles::UserProfiles::Pro::App::UserProfiles::get_image
+
+config_settings:
+  UserProfilesScript:
+    default: 'plugins/UserProfiles/profiles.cgi'
+    path: 1
+
+callbacks:
+  MT::App::CMS::template_source.users_content_nav: $UserProfiles::UserProfiles::Pro::Callbacks::users_content_nav
+  MT::Comment::post_save: $UserProfiles::UserProfiles::Pro::Callbacks::post_save_comment
+  MT::Entry::post_save: $UserProfiles::UserProfiles::Pro::Callbacks::post_save_entry
+  MT::Author::post_save: $UserProfiles::UserProfiles::Pro::Callbacks::post_save_author
+  UserProfiles::Pro::Object::Profile::post_save: $UserProfiles::UserProfiles::Pro::Callbacks::post_save_profile
+  MT::Template::post_save: $UserProfiles::UserProfiles::Pro::Callbacks::post_save_template
+#   MT::App::CMS::template_param.edit_author: $UserProfiles::UserProfiles::Callbacks::edit_author
+#   MT::App::CMS::template_param.dialog/asset_options: $UserProfiles::UserProfiles::Callbacks::asset_options_params
+#   MT::App::CMS::template_param.asset_options: $UserProfiles::UserProfiles::Callbacks::asset_options_params
+#   MT::App::CMS::template_source.asset_options: $UserProfiles::UserProfiles::Callbacks::asset_options
+#   MT::App::CMS::template_source.this_is_you: $UserProfiles::UserProfiles::Callbacks::this_is_you
+
+tags:
+  function:
+    AuthorImageURL: $UserProfiles::UserProfiles::Tags::author_image_url
+    CommenterImageURL: $UserProfiles::UserProfiles::Tags::commenter_image_url
+    UserProfilesScript: $UserProfiles::UserProfiles::Tags::user_profiles_script
+    AuthorProfileURL: $UserProfiles::UserProfiles::Pro::Tags::author_profile_url
+    CommenterProfileURL: $UserProfiles::UserProfiles::Pro::Tags::commenter_profile_url
+    UserProfile: $UserProfiles::UserProfiles::Pro::Tags::user_profile_tag
+	CommentAuthorLink: $UserProfiles::UserProfiles::Pro::Tags::comment_author_link
+	EntryAuthorLink: $UserProfiles::UserProfiles::Pro::Tags::entry_author_link
+    UserPostCount: $UserProfiles::UserProfiles::Pro::Tags::post_count
+    AuthorPostCount: $UserProfiles::UserProfiles::Pro::Tags::post_count
+    CommenterPostCount: $UserProfiles::UserProfiles::Pro::Tags::post_count
+    UserJoinDate: $UserProfiles::UserProfiles::Pro::Tags::join_date
+    AuthorJoinDate: $UserProfiles::UserProfiles::Pro::Tags::join_date
+    CommenterJoinDate: $UserProfiles::UserProfiles::Pro::Tags::join_date
+  block:
+    IfAuthorImage?: $UserProfiles::UserProfiles::Tags::if_author_image
+    IfCommenterImage?: $UserProfiles::UserProfiles::Tags::if_commenter_image
+    AuthorComments: $UserProfiles::UserProfiles::Pro::Tags::author_comments
+
+upgrade_functions:
+  import_images:
+    version_limit: 1.231
+    updater:
+      type: author
+      label: 'Importing author photos...',
+      condition: >
+          sub { !$_[0]->profile_asset_id && !$_[0]->userpic_asset_id }
+      code: $UserProfile::UserProfiles::Pro::Util::import_images
+  migrate_userpics:
+    version_limit: 17
+    updater:
+      type: 'author'
+      label: 'Migrating userpics...'
+      condition: >
+          sub { $_[0]->profile_asset_id && !$_[0]->userpic_asset_id }
+      code: $UserProfile::UserProfiles::Upgrade::migrate_userpics

plugins/UserProfiles/default_templates/templates/edit_user_profile.mtml → addons/UserProfiles.plugin/default_templates/edit_user_profile.mtml

@@ -110,9 +110,7 @@
 
 </form>
 
-<MTIfUserProfilesPro>
   <p><a href="javascript:void(0)" onclick="return ExtendedProfile();">Edit Extended Profile</a></p>
-</MTIfUserProfilesPro>
 
 </div>
 
@@ -158,7 +156,6 @@
 
 </div>
 
-<MTIfUserProfilesPro>
 <div id="edit-extended-profile"<mt:unless name="extended_profile"> style="display: none"</mt:unless>>
 
     <form name="userprofile" id="userprofile" method="post" action="<mt:var name="script_url">">
@@ -189,7 +186,6 @@
     </form>
 
 </div>
-</MTIfUserProfilesPro>
 
 <mt:if name="entry_url">
 <p>Return to the <a href="<mt:var name="entry_url">">original entry</a>.</p>
@@ -206,15 +202,13 @@ function Upload() {
 } 
 function CancelUpload() {
   hideDocumentElement('upload-photo');
-<MTIfUserProfilesPro>  hideDocumentElement('edit-extended-profile'); </MTIfUserProfilesPro>
+  hideDocumentElement('edit-extended-profile');
   showDocumentElement('edit-profile');
 }
-<MTIfUserProfilesPro>
 function ExtendedProfile() {
   hideDocumentElement('edit-profile');
   showDocumentElement('edit-extended-profile');
 }
-</MTIfUserProfilesPro>
 function hide(id) {
   hideDocumentElement(id);
 }

plugins/UserProfiles/default_templates/templates/javascript.mtml → addons/UserProfiles.plugin/default_templates/javascript.mtml

@@ -170,9 +170,7 @@ function writeCommenterGreeting(commenter_name, entry_id, blog_id, commenter_id,
         }
         content += '. Now you can comment. (<a href="<$MTRemoteSignOutLink static="1"$>&entry_id=' + entry_id + '">sign out</a>)';
         document.write(content);
-<MTIfUserProfilesPro>
         getImage();
-</MTIfUserProfilesPro>
     } else if (commenter_name) {
             document.write('You do not have permission to comment on this blog. (<a href="<$MTRemoteSignOutLink static="1"$>&entry_id=' + entry_id + '">sign out</a>)');
     } else {
@@ -185,8 +183,6 @@ function writeCommenterGreeting(commenter_name, entry_id, blog_id, commenter_id,
 </MTIfRegistrationAllowed>
 }
 
-<MTIfUserProfilesPro>
-
 function getImage(){
 
 var commenter_img = getCookie('commenter_img');
@@ -221,7 +217,6 @@ var callback =
   var request = YAHOO.util.Connect.asyncRequest('POST', sUrl, callback, postData);
   return false;
 }
-</MTIfUserProfilesPro>
 
 <MTIfRegistrationAllowed>
 if ('<$MTCGIHost exclude_port="1"$>' != '<$MTBlogHost exclude_port="1"$>') {