Changeset 510

Timestamp:

07/24/07 12:10:07 (1 year ago)

Author:

louisedade

Message:

avatar-upload: committing version 0.7 - added admin page, unsharp mask and changed file layout

Files:

• avatar-upload/trunk/additional-files (added)
• avatar-upload/trunk/additional-files/avatar-upload.php (moved) (moved from avatar-upload/trunk/avatar-upload.php) (6 diffs)
• avatar-upload/trunk/additional-files/avatars (moved) (moved from avatar-upload/trunk/avatars)
• avatar-upload/trunk/additional-files/my-templates (moved) (moved from avatar-upload/trunk/my-templates)
• avatar-upload/trunk/additional-files/my-templates/avatar.php (copied) (copied from avatar-upload/trunk/my-templates/avatar.php)
• avatar-upload/trunk/bb-avatar-upload.php (copied) (copied from avatar-upload/trunk/my-plugins/bb-avatar-upload.php) (4 diffs)
• avatar-upload/trunk/identicon.php (copied) (copied from avatar-upload/trunk/my-plugins/identicon.php)
• avatar-upload/trunk/my-plugins (deleted)
• avatar-upload/trunk/readme.txt (modified) (7 diffs)
• avatar-upload/trunk/unsharpmask.php (added)

avatar-upload/trunk/additional-files/avatar-upload.php

@@ -1 +1 @@
-<?php
-/*
-
-
-
-
-
-
+
-*/
-
@@ -145 +140 @@
-                                break;
-                        case 8: // UPLOAD_ERR_EXTENSION (since PHP 5.2.0)
-The file is not a valid GIF, JPG/JPEG or PNG image-type."
+You are not allowed to upload images of the type: ".strtoupper($img_ext)
-                                break;
-                        case 9: // custom error code
@@ -154 +149 @@
-                                break;
-                        case 11: // custom error code
-'avatars'
+{$config->avatar_dir}
-                                break;
-                        default: // unknown error (this probably won't ever happen)
@@ -208 +203 @@
-                return array($img_w, $img_h);
-        }
+
+        // Can we use a truecolor image?
+        $truecolor = function_exists('imagecreatetruecolor');
-
-        // Resize the image preserving image type
@@ -224 +222 @@
-                        // JPEG
-                        $im1 = @imagecreatefromjpeg($img_temp);
-@imagecreatetruecolor($new_width, $new_height) or $error = 1
+($truecolor) ? @imagecreatetruecolor($new_width, $new_height) : @imagecreate($new_width, $new_height)
-                        @imagecopyresampled ($im2, $im1, 0, 0, 0, 0, $new_width, $new_height, $img_w, $img_h);
+                        $im2 = ($truecolor) ? do_unsharp_mask($im2, $config->use_unsharpmask) : $im2;
-                        @imagejpeg($im2, $img_temp, 100); // quality integer might become config variable
-                        break;
@@ -232 +231 @@
-                        // PNG
-                        $im1 = @imagecreatefrompng($img_temp);
-@imagecreatetruecolor($new_width, $new_height) or $error = 1
+($truecolor) ? @imagecreatetruecolor($new_width, $new_height) : @imagecreate($new_width, $new_height)
-                        @imagecopyresampled ($im2, $im1, 0, 0, 0, 0, $new_width, $new_height, $img_w, $img_h);
+                        $im2 = ($truecolor) ? do_unsharp_mask($im2, $config->use_unsharpmask) : $im2;
-                        @imagepng($im2, $img_temp);
-                        break;

avatar-upload/trunk/bb-avatar-upload.php

@@ -3 +3 @@
-Plugin Name: Avatar Upload
-Plugin URI: http://bbpress.org/plugins/topic/46
-6.2
+7
-Description: Allows users to upload an avatar (gif, jpeg/jpg or png) image to bbPress.
-Author: Louise Dade
@@ -14 +14 @@
-        function avatarupload_config()
-        {
+                // Set default options
+                $options = array(
+                        'avatar_dir'     => 'avatars/',
+                        'max_width'      => 150,
+                        'max_height'     => 150,
+                        'max_bytes'      => 1048576,
+                        'use_default'    => 1,
+                        'identicon_size' => 100,
+                        'file_extns' => array("gif", "jpg", "jpeg", "png")
+                );
+                
+                // Get database options
+                $db_options = bb_get_option('avatar_upload_options');
+                
+                // If there are options in the database
+                if ($db_options) {
+                        // The database options override the defaults
+                        $options = array_merge($options, $db_options);
+                }
+                
+                // If there is no trailing slash on the directory then add it
+                if (substr($options['avatar_dir'], -1) != '/') {
+                        $options['avatar_dir'] .= '/';
+                }
+                
-                // Avatar folder location (default is 'avatars' in the bbPress root folder)
-                // You must create the folder before you install this plugin.
-"avatars/"; // remember to include trailing slash
-
+$options['avatar_dir'];
+
-                // Define maximum values allowed
-
-
-
-
+
+
+
+
+
+
+
-                // Default avatar - set 'use_default' to '0' to display Identicon instead of default
-                // The default URI is in the '$this->avatar_dir' folder.
-                $this->default_avatar = array(  
-1
+$options['use_default']
-                        'uri' =>  bb_get_option('uri') . $this->avatar_dir . 'default.png',
-                        'width' => 80,
@@ -32 +60 @@
-                        'alt' => "User has not uploaded an avatar"
-                );
-
+
-                // Identicon dimensions (width/height are equal):
-config->identicon_size = 100
-
+this->identicon_size = $options['identicon_size']
+
-                // Allowed file extensions
-array("gif", "jpg", "jpeg", "png")
-
+$options['file_extns']
+
-                // Just pretty values (Kilobytes/megabytes) for output use
-                $this->max_kbytes = round($this->max_bytes / 1024, 2);
@@ -162 +190 @@
-}
-
+
+// Unsharp Mask on image resize (truecolor images only)
+function do_unsharp_mask($img, $use_unsharpmask=0)
+{
+        if ($use_unsharpmask == 1)
+        {
+                require_once("unsharpmask.php");
+                return UnsharpMask($img, 80, 0.5, 3);
+        }
+        else
+        {
+                return $img;
+        }
+}
+
+/**
+ * The admin pages below are handled outside of the class due to constraints
+ * in the architecture of the admin menu generation routine in bbPress
+ */
+
+
+// Add filters for the admin area
+add_action('bb_admin_menu_generator', 'avatar_upload_admin_page_add');
+add_action('bb_admin-header.php', 'avatar_upload_admin_page_process');
+
+
+/**
+ * Adds in an item to the $bb_admin_submenu array
+ *
+ * @return void
+ * @author Sam Bauers
+ **/
+function avatar_upload_admin_page_add() {
+        if (function_exists('bb_admin_add_submenu')) { // Build 794+
+                bb_admin_add_submenu(__('Avatar Upload'), 'use_keys', 'avatar_upload_admin_page');
+        } else {
+                global $bb_submenu;
+                $submenu = array(__('Avatar Upload'), 'use_keys', 'avatar_upload_admin_page');
+                if (isset($bb_submenu['plugins.php'])) { // Build 740-793
+                        $bb_submenu['plugins.php'][] = $submenu;
+                } else { // Build 277-739
+                        $bb_submenu['site.php'][] = $submenu;
+                }
+        }
+}
+
+
+/**
+ * Writes an admin page for the plugin
+ *
+ * @return string
+ * @author Sam Bauers
+ * @modified Louise Dade
+ **/
+function avatar_upload_admin_page() {
+        
+        $config = new avatarupload_config();
+        
+        $gif_checked = (in_array('gif', $config->file_extns)) ? "checked=\"checked\" " : "";
+        $jpg_checked = (in_array('jpg', $config->file_extns)) ? "checked=\"checked\" " : "";
+        $png_checked = (in_array('png', $config->file_extns)) ? "checked=\"checked\" " : "";
+
+        $use_default_checked = ($config->default_avatar['use_default']) ? "checked=\"checked\" " : "";
+        $identicons_checked  = ($config->default_avatar['use_default']) ? "" : "checked=\"checked\" ";
-?>
+        <h2>Avatar Upload Settings</h2>
+        <form method="post">
+
+        <table cellpadding="5">
+        <tr>
+                <th scope="row" width="360"><label for="avatar_dir">Directory to where avatars are uploaded:</label></th>
+                <td><code>bbPressRootDirectory/</code><input type="text" name="avatar_dir" id="avatar_dir" size="20" value="<?php echo($config->avatar_dir); ?>" /> <em>(location must be writable by the web server)</em></td>
+        </tr>
+        <tr>
+                <th scope="row"><label for="max_width">Maximum allowed width of avatars in pixels:</label></th>
+                <td><input type="text" name="max_width" id="max_width" size="4" value="<?php echo($config->max_width); ?>" /> pixels</td>
+        </tr>
+        <tr>
+                <th scope="row"><label for="max_height">Maximum allowed height of avatars in pixels:</label></th>
+                <td><input type="text" name="max_height" id="max_height" size="4" value="<?php echo($config->max_height); ?>" /> pixels</td>
+        </tr>
+        <tr>
+                <th scope="row"><label for="max_bytes">Maximum allowed filesize of avatars in bytes:</label></th>
+                <td><input type="text" name="max_bytes" id="max_bytes" size="10" value="<?php echo($config->max_bytes); ?>" /> bytes (n.b. 1 KB = 1024 bytes)</td>
+        </tr>
+        <tr>
+                <th scope="row">Allow the following image types to be uploaded:</th>
+                <td>
+                <label><input type="checkbox" name="file_extns[]" value="gif" <?php echo($gif_checked); ?>/> GIF (*.gif)</label><br />
+                <label><input type="checkbox" name="file_extns[]" value="jpg"  <?php echo($jpg_checked); ?>/> JPEG (*.jpeg; *.jpg)</label><br />
+                <label><input type="checkbox" name="file_extns[]" value="png"  <?php echo($png_checked); ?>/> PNG (*.png)</label>
+                </td>
+        </tr>
+        <tr>
+                <th scope="row">Action to take when a user has no avatar present:</th>
+                <td>
+                <label><input type="radio" name="use_default" value="1" <?php echo($use_default_checked); ?>/> Use the default avatar image</label> 
+                (<a href="<?php echo $config->default_avatar['uri']; ?>" target="_blank" title="View default avatar in a new window">view</a>).<br />
+                <label><input type="radio" name="use_default" value="0" <?php echo($identicons_checked); ?>/> Use an auto generated identicon</label>
+                </td>
+        </tr>
+        <tr>
+                <th scope="row"><label for="identicon_size">Height &amp; width of identicons in pixels (if used):</label></th>
+                <td><input type="text" name="identicon_size" id="identicon_size" size="4" value="<?php echo($config->identicon_size); ?>" /> pixels</td>
+        </tr>
+        </table>
+                <input name="action" type="hidden" value="avatar_upload_settings_post"/>
+                <p class="submit"><input type="submit" name="submit" value="Save Avatar Upload Settings" /></p>
+        </form>
+
+        <h3>Don't Forget!</h3>
+
+        <p>If you haven't already done so: upload the files in the "additional-files" directory to the following locations.</p>
+        <ul>
+                <li><code>avatars/</code> - directory to the location specified on the admin page, rename if neccesary.</li>
+                <li><code>avatars/default.png</code> - default avatar image into the directory created above.</li>
+                <li><code>avatar-upload.php</code> - bbPress root directory.</li>
+                <li><code>my-templates/avatar.php</code> - your <code>my-templates/my-template-name/</code> (or <code>bb-templates/kakumei/</code>) directory.</li>
+        </ul>
+
+<p><strong>Read the <code>readme.txt</code> file that came with this plugin for more detailed instructions.</strong></p>
+
+<?php
+}
+
+
+/**
+ * Processes the admin page form
+ *
+ * @return void
+ * @author Sam Bauers
+ * @modified Louise Dade
+ **/
+function avatar_upload_admin_page_process()
+{
+        if (isset($_POST['submit'])) {
+                if ($_POST['action'] == 'avatar_upload_settings_post') {
+                        
+                        $options = array();
+                        
+                        if ($_POST['avatar_dir']) {
+                                $options['avatar_dir'] = $_POST['avatar_dir'];
+                        }
+                        
+                        if (ereg("^[0-9]{1,}$", $_POST['max_width'])) {
+                                $options['max_width'] = $_POST['max_width'];
+                        }
+                        
+                        if (ereg("^[0-9]{1,}$", $_POST['max_height'])) {
+                                $options['max_height'] = $_POST['max_height'];
+                        }
+                        
+                        if (ereg("^[0-9]{1,}$", $_POST['max_bytes'])) {
+                                $options['max_bytes'] = $_POST['max_bytes'];
+                        }
+                        
+                        if ($_POST['file_extns']) {
+                                $valid = array("gif", "jpg", "png"); // not user configurable!
+
+                                foreach ($_POST['file_extns'] as $extn)
+                                {
+                                        if (in_array($extn, $valid)) {
+                                                $options['file_extns'][] = $extn;
+                                                if ($extn == "jpg") {
+                                                        $options['file_extns'][] = "jpeg";
+                                                }
+                                        }
+                                }
+                        }
+                        
+                        if (!$_POST['use_default']) {
+                                $options['use_default'] = 0;
+                        }
+                        
+                        if (ereg("^[0-9]{1,}$", $_POST['identicon_size'])) {
+                                $options['identicon_size'] = $_POST['identicon_size'];
+                        }
+                        
+                        if (count($options)) {
+                                bb_update_option('avatar_upload_options', $options);
+                        } else {
+                                bb_delete_option('avatar_upload_options');
+                        }
+                        
+                        bb_admin_notice(__('Settings Saved'));
+                }
+        }
+}
+?>

avatar-upload/trunk/readme.txt

@@ -4 +4 @@
-Requires at least: 0.8.2
-Tested up to: 0.8.2.1
-6.2
+7
-
-Allows users to upload an avatar (gif, jpeg/jpg or png) image to bbPress. Admins can configure maximum allowed file size and image dimensions. Includes fel64's code enabling 'Identicons' - default avatars made of abstract patterns unique to each user.
@@ -20 +20 @@
-* Bozos can not upload avatars.
-
-
+ from within the admin page (credit: Sam Bauers)
-
-
-
-
+
-
-* Anybody with the 'moderate' capability can upload another user's avatar
@@ -30 +28 @@
-  - this to ensures that inappropriate images can be removed.
-
-
+ Alternatively, you could set their avatar to an identicon (see below).
-
-* Option to display a default avatar for users who do not upload their own.
@@ -40 +38 @@
-== Installation ==
-
-n older version of this plugin, you need to follow these installation instructions because the template functions are incompatible with older versions
+ version older than 0.3 of this plugin you NEED to follow these instructions fully because the template functions are incompatible with older versions.  If you are upgrading from version 0.3 or later then of this plugin you can ignore the template instructions (steps 2 to 4), but do check the rest
-
-
-
-
-
-
+
-
-2. The avatar upload page should appear as a tab ("Avatar") on the user's Profile menu.  If you'd prefer the link to be elsewhere, insert the following "Upload Avatar" link wherever you wish:
@@ -76 +70 @@
-4. OPTIONAL: open up `my-templates/avatar.php` and edit the template if you wish, but be sure not to mess with the upload form.
-
-plugin files
+files in the "additional-files" directory
-
-default.png`             - both `avatars/` dir and image into the bbPress root dir.
+`                    - directory to the location specified on the admin page, rename if neccesary
-
--upload.php`               - bbPress root dir
+s/default.png`         - default avatar image into the directory created above
-
-my-templates/avatar.php`         - your `my-templates/my-template-name/` (or kakumei) dir
+avatar-upload.php`           - bbPress root directory
-
-plugins/bb-avatar-upload.php` - your `my-plugins/` dir (and activated)
+templates/avatar.php`     - your `my-templates/my-template-name/` (or bb-templates/kakumei/) directory
-
-
+
+
+
+
+
+
+
-
-That's it, the 'Avatar Upload' plugin should now be working.
@@ -92 +92 @@
-== Configuration ==
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-== Frequently Asked Questions ==
@@ -106 +122 @@
-You need to set the file permissions (chmod) of the `avatars` folder to `666` to allow the plugin to write to the folder.  You can do this using SHH or alternatively (and more easily) many FTP applications allow permissions setting.  Please refer to your web host for their advice if you do not know how to do this.
-
+= When I upload some JPEGs they either look rubbish or are blocks of plain colour =
+
+[N.b. this can also apply to some PNG images, but I'm only going to talk about JPEGS.]
+
+This is most likely a result of your web host providing a version of PHP that can not create 'truecolor' images. JPEGS are usually photographic images and therefore contain millions of colours, hence the need for truecolor. The plugin detects if truecolor is not an option and instead uses the same function as GIF (palette based) images, which can make some JPEGS look awful.
+
+To get the best out of a JPEG image you really need <strong>PHP version >= 4.0.6 or PHP 5 and GD library GD 2.0.1 or later</strong>.
+
+Alternatively, because this only happens when an image needs to be resized, you could inform your uses that they <strong>must</strong> make sure they avatar conforms to the maximum allowed dimensions <em>before</em> they upload it.
+
-== Change Log ==
+
+2007-07-23 Ver. 0.7   Added admin page for configuration, added an unsharp mask function, changed 
+                      additional file layout to be more friendly to the Plugin Browser plugin.
-
-2007-07-19 Ver. 0.6.2 Bug-fix. 'Upload Avatar' page wasn't displaying new avatar after upload.