First I created an extra config for ACL (could be also in module.config.php, but I prefer to have it in a separated file)

• config/acl.config.php

<?php
return array(
    'acl' => array(
        'roles' => array(
            'guest'   => null,
            'member'  => 'guest'
        ),
        'resources' => array(
            'allow' => array(
                'user' => array(
                    'login' => 'guest',
                    'all'   => 'member'
                )
            )
        )
    )
);

Next step is to create the Acl Class where we manage the roles and resources which we have defined in the config

• src/User/Acl/Acl.php

<?php
/**
 * File for Acl Class
 *
 * @category  User
 * @package   User_Acl
 * @author    Marco Neumann <webcoder_at_binware_dot_org>
 * @copyright Copyright (c) 2011, Marco Neumann
 * @license   http://binware.org/license/index/type:new-bsd New BSD License
 */

/**
 * @namespace
 */
namespace User\Acl;

/**
 * @uses Zend\Acl\Acl
 * @uses Zend\Acl\Role\GenericRole
 * @uses Zend\Acl\Resource\GenericResource
 */
use Zend\Acl\Acl as ZendAcl,
    Zend\Acl\Role\GenericRole as Role,
    Zend\Acl\Resource\GenericResource as Resource;

/**
 * Class to handle Acl
 *
 * This class is for loading ACL defined in a config
 *
 * @category User
 * @package  User_Acl
 * @copyright Copyright (c) 2011, Marco Neumann
 * @license   http://binware.org/license/index/type:new-bsd New BSD License
 */
class Acl extends ZendAcl {
    /**
     * Default Role
     */
    const DEFAULT_ROLE = 'guest';

    /**
     * Constructor
     *
     * @param array $config
     * @return void
     * @throws \Exception
     */
    public function __construct($config)
    {
        if (!isset($config['acl']['roles']) || !isset($config['acl']['resources'])) {
            throw new \Exception('Invalid ACL Config found');
        }

        $roles = $config['acl']['roles'];
        if (!isset($roles[self::DEFAULT_ROLE])) {
            $roles[self::DEFAULT_ROLE] = '';
        }

        $this->_addRoles($roles)
             ->_addResources($config['acl']['resources']);
    }

    /**
     * Adds Roles to ACL
     *
     * @param array $roles
     * @return User\Acl
     */
    protected function _addRoles($roles)
    {
        foreach ($roles as $name => $parent) {
            if (!$this->hasRole($name)) {
                if (empty($parent)) {
                    $parent = array();
                } else {
                    $parent = explode(',', $parent);
                }

                $this->addRole(new Role($name), $parent);
            }
        }

        return $this;
    }

    /**
     * Adds Resources to ACL
     *
     * @param $resources
     * @return User\Acl
     * @throws \Exception
     */
    protected function _addResources($resources)
    {
        foreach ($resources as $permission => $controllers) {
            foreach ($controllers as $controller => $actions) {
                if ($controller == 'all') {
                    $controller = null;
                } else {
                    if (!$this->hasResource($controller)) {
                        $this->addResource(new Resource($controller));
                    }
                }

                foreach ($actions as $action => $role) {
                    if ($action == 'all') {
                        $action = null;
                    }

                    if ($permission == 'allow') {
                        $this->allow($role, $controller, $action);
                    } elseif ($permission == 'deny') {
                        $this->deny($role, $controller, $action);
                    } else {
                        throw new \Exception('No valid permission defined: ' . $permission);
                    }
                }
            }
        }

        return $this;
    }
}

I decided to use a Controller Plugin (zf1 ActionHelpers) for the Authentication interaction

• src/User/Controller/Plugin/UserAuthentication.php

<?php
/**
 * File for UserAuthentication Class
 *
 * @category   User
 * @package    User_Controller
 * @subpackage User_Controller_Plugin
 * @author     Marco Neumann <webcoder_at_binware_dot_org>
 * @copyright  Copyright (c) 2011, Marco Neumann
 * @license    http://binware.org/license/index/type:new-bsd New BSD License
 */

/**
 * @namespace
 */
namespace User\Controller\Plugin;

/**
 * @uses Zend\Mvc\Controller\Plugin\AbstractPlugin
 * @uses Zend\Authentication\AuthenticationService
 * @uses Zend\Authentication\Adapter\DbTable
 */
use Zend\Mvc\Controller\Plugin\AbstractPlugin,
    Zend\Authentication\AuthenticationService,
    Zend\Authentication\Adapter\DbTable as AuthAdapter;

/**
 * Class for User Authentication
 *
 * Handles Auth Adapter and Auth Service to check Identity
 *
 * @category   User
 * @package    User_Controller
 * @subpackage User_Controller_Plugin
 * @copyright  Copyright (c) 2011, Marco Neumann
 * @license    http://binware.org/license/index/type:new-bsd New BSD License
 */
class UserAuthentication extends AbstractPlugin
{
    /**
     * @var AuthAdapter
     */
    protected $_authAdapter = null;

    /**
     * @var AuthenticationService
     */
    protected $_authService = null;

    /**
     * Check if Identity is present
     *
     * @return bool
     */
    public function hasIdentity()
    {
        return $this->getAuthService()->hasIdentity();
    }

    /**
     * Return current Identity
     *
     * @return mixed|null
     */
    public function getIdentity()
    {
        return $this->getAuthService()->getIdentity();
    }

    /**
     * Sets Auth Adapter
     *
     * @param \Zend\Authentication\Adapter\DbTable $authAdapter
     * @return UserAuthentication
     */
    public function setAuthAdapter(AuthAdapter $authAdapter)
    {
        $this->_authAdapter = $authAdapter;

        return $this;
    }

    /**
     * Returns Auth Adapter
     *
     * @return \Zend\Authentication\Adapter\DbTable
     */
    public function getAuthAdapter()
    {
        if ($this->_authAdapter === null) {
            $this->setAuthAdapter(new AuthAdapter());
        }

        return $this->_authAdapter;
    }

    /**
     * Sets Auth Service
     *
     * @param \Zend\Authentication\AuthenticationService $authService
     * @return UserAuthentication
     */
    public function setAuthService(AuthenticationService $authService)
    {
        $this->_authService = $authService;

        return $this;
    }

    /**
     * Gets Auth Service
     *
     * @return \Zend\Authentication\AuthenticationService
     */
    public function getAuthService()
    {
        if ($this->_authService === null) {
            $this->setAuthService(new AuthenticationService());
        }

        return $this->_authService;
    }

}

Now we can create the Event Handler were we will implement the AuthenticationPlugin (at this point, I think that using a Controller Plugin is not the right way to do it, but for now I will leave it so until I have a better solution…) and the Acl

• src/Event/Authentication.php

<?php
/**
 * File for Event Class
 *
 * @category  User
 * @package   User_Event
 * @author    Marco Neumann <webcoder_at_binware_dot_org>
 * @copyright Copyright (c) 2011, Marco Neumann
 * @license   http://binware.org/license/index/type:new-bsd New BSD License
 */

/**
 * @namespace
 */
namespace User\Event;

/**
 * @uses Zend\Mvc\MvcEvent
 * @uses User\Controller\Plugin\UserAuthentication
 * @uses User\Acl\Acl
 */
use Zend\Mvc\MvcEvent as MvcEvent,
    User\Controller\Plugin\UserAuthentication as AuthPlugin,
    User\Acl\Acl as AclClass;

/**
 * Authentication Event Handler Class
 *
 * This Event Handles Authentication
 *
 * @category  User
 * @package   User_Event
 * @copyright Copyright (c) 2011, Marco Neumann
 * @license   http://binware.org/license/index/type:new-bsd New BSD License
 */
class Authentication
{
    /**
     * @var AuthPlugin
     */
    protected $_userAuth = null;

    /**
     * @var AclClass
     */
    protected $_aclClass = null;

    /**
     * preDispatch Event Handler
     *
     * @param \Zend\Mvc\MvcEvent $event
     * @throws \Exception
     */
    public function preDispatch(MvcEvent $event)
    {
        //@todo - Should we really use here and Controller Plugin?
        $userAuth = $this->getUserAuthenticationPlugin();
        $acl = $this->getAclClass();
        $role = AclClass::DEFAULT_ROLE;

        if ($userAuth->hasIdentity()) {
            $user = $userAuth->getIdentity();
            $role = 'member'; //@todo - Get role from user!
        }

        $routeMatch = $event->getRouteMatch();
        $controller = $routeMatch->getParam('controller');
        $action     = $routeMatch->getParam('action');

        if (!$acl->hasResource($controller)) {
            throw new \Exception('Resource ' . $controller . ' not defined');
        }

        if (!$acl->isAllowed($role, $controller, $action)) {
            $url = $event->getRouter()->assemble(array(), array('name' => 'login'));
            $response = $event->getResponse();
            $response->headers()->addHeaderLine('Location', $url);
            $response->setStatusCode(302);
            $response->sendHeaders();
            exit;
        }
    }

    /**
     * Sets Authentication Plugin
     *
     * @param \User\Controller\Plugin\UserAuthentication $userAuthenticationPlugin
     * @return Authentication
     */
    public function setUserAuthenticationPlugin(AuthPlugin $userAuthenticationPlugin)
    {
        $this->_userAuth = $userAuthenticationPlugin;

        return $this;
    }

    /**
     * Gets Authentication Plugin
     *
     * @return \User\Controller\Plugin\UserAuthentication
     */
    public function getUserAuthenticationPlugin()
    {
        if ($this->_userAuth === null) {
            $this->_userAuth = new AuthPlugin();
        }

        return $this->_userAuth;
    }

    /**
     * Sets ACL Class
     *
     * @param \User\Acl\Acl $aclClass
     * @return Authentication
     */
    public function setAclClass(AclClass $aclClass)
    {
        $this->_aclClass = $aclClass;

        return $this;
    }

    /**
     * Gets ACL Class
     *
     * @return \User\Acl\Acl
     */
    public function getAclClass()
    {
        if ($this->_aclClass === null) {
            $this->_aclClass = new AclClass(array());
        }

        return $this->_aclClass;
    }
}

Now we need to attach the Event Handler to the EventManager, this will be done in the Module Class (haven’t found a better way to do it). I also had to attach an own function and from there trigger the User\Event\Authentication function (not very elegant ;( )

• Module.php

<?php
/**
 * File for Module Class
 *
 * @category  User
 * @package   User
 * @author    Marco Neumann <webcoder_at_binware_dot_org>
 * @copyright Copyright (c) 2011, Marco Neumann
 * @license   http://binware.org/license/index/type:new-bsd New BSD License
 */

/**
 * @namespace
 */
namespace User;

/**
 * @uses Zend\Module\Consumer\AutoloaderProvider
 * @uses Zend\EventManager\StaticEventManager
 */
use Zend\Module\Consumer\AutoloaderProvider,
    Zend\EventManager\StaticEventManager;

/**
 * Module Class
 *
 * Handles Module Initialization
 *
 * @category  User
 * @package   User
 * @copyright Copyright (c) 2011, Marco Neumann
 * @license   http://binware.org/license/index/type:new-bsd New BSD License
 */
class Module implements AutoloaderProvider
{
    /**
     * Init function
     *
     * @return void
     */
    public function init()
    {
        // Attach Event to EventManager
        $events = StaticEventManager::getInstance();
        $events->attach('Zend\Mvc\Controller\ActionController', 'dispatch', array($this, 'mvcPreDispatch'), 100); //@todo - Go directly to User\Event\Authentication
    }

    /**
     * Get Autoloader Configuration
     *
     * @return array
     */
    public function getAutoloaderConfig()
    {
        return array(
            'Zend\Loader\ClassMapAutoloader' => array(
                __DIR__ . '/autoload_classmap.php'
            ),
            'Zend\Loader\StandardAutoloader' => array(
                'namespaces' => array(
                    __NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__
                )
            )
        );
    }

    /**
     * Get Module Configuration
     *
     * @return array
     */
    public function getConfig()
    {
        return include __DIR__ . '/config/module.config.php';
    }

    /**
     * MVC preDispatch Event
     *
     * @param $event
     * @return mixed
     */
    public function mvcPreDispatch($event) {
        $di = $event->getTarget()->getLocator();
        $auth = $di->get('User\Event\Authentication');

        return $auth->preDispatch($event);
    }
}

Here is the config where we attach all needed classes and load acl.config.php

• config/module.config.php

<?php
return array(
    'di' => array(
        'instance' => array(
            'alias' => array(
                'user' => 'User\Controller\UserController'
            ),
            'user' => array(
                'parameters' => array(
                    'broker' => 'Zend\Mvc\Controller\PluginBroker'
                )
            ),
            'User\Event\Authentication' => array(
                'parameters' => array(
                    'userAuthenticationPlugin' => 'User\Controller\Plugin\UserAuthentication',
                    'aclClass'                 => 'User\Acl\Acl'
                )
            ),
            'User\Acl\Acl' => array(
                'parameters' => array(
                    'config' => include __DIR__ . '/acl.config.php'
                )
            ),
            'User\Controller\Plugin\UserAuthentication' => array(
                'parameters' => array(
                    'authAdapter' => 'Zend\Authentication\Adapter\DbTable'
                )
            ),
            'Zend\Authentication\Adapter\DbTable' => array(
                'parameters' => array(
                    'zendDb' => 'Zend\Db\Adapter\Mysqli',
                    'tableName' => 'users',
                    'identityColumn' => 'email',
                    'credentialColumn' => 'password',
                    'credentialTreatment' => 'SHA1(CONCAT(?, "secretKey"))'
                )
            ),
            'Zend\Db\Adapter\Mysqli' => array(
                'parameters' => array(
                    'config' => array(
                        'host' => 'localhost',
                        'username' => 'username',
                        'password' => 'password',
                        'dbname' => 'dbname',
                        'charset' => 'utf-8'
                    )
                )
            ),
            'Zend\Mvc\Controller\PluginLoader' => array(
                'parameters' => array(
                    'map' => array(
                        'userAuthentication' => 'User\Controller\Plugin\UserAuthentication'
                    )
                )
            ),
            'Zend\View\PhpRenderer' => array(
                'parameters' => array(
                    'options' => array(
                        'script_paths' => array(
                            'user' => __DIR__ . '/../views'
                        )
                    )
                )
            )
        )
    ),
    'routes' => array(
        'login' => array(
            'type' => 'Zend\Mvc\Router\Http\Literal',
            'options' => array(
                'route'    => '/login',
                'defaults' => array(
                    'controller' => 'user',
                    'action'     => 'login',
                )
            )
        )
    )
);

Well, we are now done, we only need to create the Login Form and the Controller

• src/Form/Login.php

<?php
/**
 * File for Login Form Class
 *
 * @category  User
 * @package   User_Form
 * @author    Marco Neumann <webcoder_at_binware_dot_org>
 * @copyright Copyright (c) 2011, Marco Neumann
 * @license   http://binware.org/license/index/type:new-bsd New BSD License
 */

/**
 * @namespace
 */
namespace User\Form;

/**
 * @uses Zend\Form\Form
 */
use Zend\Form\Form;

/**
 * Login Form Class
 *
 * Login Form
 *
 * @category  User
 * @package   User_Form
 * @copyright Copyright (c) 2011, Marco Neumann
 * @license   http://binware.org/license/index/type:new-bsd New BSD License
 */
class Login extends Form
{
    /**
     * Initialize Form
     */
    public function init()
    {
        $this->setMethod('post')
             ->loadDefaultDecorators()
             ->addDecorator('FormErrors');

        $this->addElement(
            'text',
            'username',
            array(
                 'filters' => array(
                     array('StringTrim')
                 ),
                 'validators' => array(
                     'EmailAddress'
                 ),
                 'required' => true,
                 'label'    => 'Email'
            )
        );

        $this->addElement(
            'password',
            'password',
            array(
                 'filters' => array(
                     array('StringTrim')
                 ),
                 'validators' => array(
                     array(
                         'StringLength',
                         true,
                         array(
                             6,
                             999
                         )
                     )
                 ),
                 'required' => true,
                 'label'    => 'Password'
            )
        );

        $this->addElement(
            'hash',
            'csrf',
            array(
                 'ignore' => true,
                 'decorators' => array('ViewHelper')
            )
        );

        $this->addElement(
            'submit',
            'login',
            array(
                 'ignore' => true,
                 'label' => 'Login'
            )
        );

    }
}

• src/User/Controller/UserController.php

<?php
/**
 * File for User Controller Class
 *
 * @category  User
 * @package   User_Controller
 * @author    Marco Neumann <webcoder_at_binware_dot_org>
 * @copyright Copyright (c) 2011, Marco Neumann
 * @license   http://binware.org/license/index/type:new-bsd New BSD License
 */

/**
 * @namespace
 */
namespace User\Controller;

/**
 * @uses Zend\Mvc\Controller\ActionController
 * @uses User\Form\Login
 */
use Zend\Mvc\Controller\ActionController,
    User\Form\Login as LoginForm;

/**
 * User Controller Class
 *
 * User Controller
 *
 * @category  User
 * @package   User_Controller
 * @copyright Copyright (c) 2011, Marco Neumann
 * @license   http://binware.org/license/index/type:new-bsd New BSD License
 */
class UserController extends ActionController
{
    /**
     * Index Action
     */
    public function indexAction()
    {
        //@todo - Implement indexAction
    }

    /**
     * Login Action
     *
     * @return array
     */
    public function loginAction()
    {
        $form = new LoginForm();
        $request = $this->getRequest();

        if ($request->isPost() && $form->isValid($request->post()->toArray())) {
            $uAuth = $this->getLocator()->get('User\Controller\Plugin\UserAuthentication'); //@todo - We must use PluginLoader $this->userAuthentication()!!
            $authAdapter = $uAuth->getAuthAdapter();

            $authAdapter->setIdentity($form->getValue('username'));
            $authAdapter->setCredential($form->getValue('password'));

            \Zend\Debug::dump($uAuth->getAuthService()->authenticate($authAdapter));
        }

        return array('loginForm' => $form);
    }

    /**
     * Logout Action
     */
    public function logoutAction()
    {
        $this->getLocator()->get('User\Controller\Plugin\UserAuthentication')->clearIdentity(); //@todo - We must use PluginLoader $this->userAuthentication()!!
    }
}

I know this is not perfect, but this implementation works. For an initial implementation I think it’s ok.

apt-get install git-core

Once git is installed we will found git-http-backend under /usr/lib/git-core/git-http-backend. Next step is to setup the Apache configuration:

<IfModule mod_ssl.c>
<VirtualHost *:443>
    SSLEngine on
 
    SSLCertificateFile /etc/ssl/server.crt
    SSLCertificateKeyFile /etc/ssl/server.key
    SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown
 
    ServerName git.example.com
    ErrorLog /var/log/apache2/git-error.log
    CustomLog /var/log/apache2/git-access.log combined
 
    # GIT Config
    SetEnv GIT_PROJECT_ROOT /opt/git/repositories
    SetEnv GIT_HTTP_EXPORT_ALL
 
    # Route Git-Http-Backend
    ScriptAlias / /usr/lib/git-core/git-http-backend/
 
    # Require Acces for all resources
    <Location />
        AuthType Basic
        AuthName "Private"
        Require valid-user
        AuthUserFile /opt/git/user.passwd
    </Location>
</VirtualHost>
</IfModule>

Now we only need to create our repositories under /opt/git/repositories (The repositories must be owned by the apache user to work):

cd /opt/git/repositories
git --bare init test.git
chown -R www-data:www-data /opt/git/repositories

And thats all, now we can checkout the repository using the url https://git.example.com/test.git:

git clone https://username@git.example.com/test.git
cd test
mkdir testdir
touch testdir/README
git add .
git commit -m 'test commit'
git push origin master

This environment variable is useful for testing and debug the request to your repository:

# Activates verbosity for HTTP Requests
export GIT_CURL_VERBOSE=1

If you have a Self-Signed Certificate and you haven’t imported your Root CA to your computer (which is the better option), you will get an SSL error. To avoid this you can use following Environment variable (CAUTION: With this you will not detect Man-In-The-Middle Attacks!)

# Do not verify Certificate
export GIT_SSL_NO_VERIFY=true

<?php

function printMemory()
{
    echo "Used " . (memory_get_peak_usage() / 1024 / 1024) . " MB\n";
}

function simpleXMLTest($nodes, $subnodes)
{
    $xml = new SimpleXMLElement("<?xml version=\"1.0\" encoding=\"utf-8\" ?><resultset/>");
    for ($i=0; $i<$nodes; $i++) {
        $node = $xml->addChild('feed' . $i);
        for ($j=0; $j<$subnodes; $j++) {
            $subnode = $node->addChild('feed' . $j);
            $subnode->addAttribute('feed', $j);
        }
    }
    printMemory();
    file_put_contents('/tmp/_test.xml', $xml->asXML());
}

function XMLWriterTest($nodes, $subnodes)
{
    $xml = new XMLWriter();
    $xml->openMemory();
    $xml->startDocument('1.0', 'UTF-8');
    $xml->startElement('resultset');
    for ($i=0; $i<$nodes; $i++) {
        $xml->startElement('test' . $i);
        for ($j=0; $j<$subnodes; $j++) {
            $xml->startElement('test' . $j);
            $xml->writeAttribute('test', $j);
            $xml->endElement();
        }
        $xml->endElement();
    }
    $xml->endElement();
    printMemory();
    file_put_contents('/tmp/_test.xml', $xml->outputMemory(true));
}

function DOMTest($nodes, $subnodes)
{
    $dom = new DOMDocument('1.0', 'utf-8');
    $resultset = $dom->createElement('resultset');
    for ($i=0; $i<$nodes; $i++) {
        $node = $dom->createElement('test' . $i);
        for ($j=0; $j<$subnodes; $j++) {
            $subnode = $dom->createElement('test' . $j);
            $subnode->setAttribute('test', $j);
            $node->appendChild($subnode);
        }
        $resultset->appendChild($node);
    }
    $dom->appendChild($resultset);
    printMemory();
    file_put_contents('/tmp/_test.xml', $dom->saveXML());
}

$nodes = 1000;
$subnodes = 100;

$start = microtime(true);

//simpleXMLTest($nodes, $subnodes);
//XMLWriterTest($nodes, $subnodes);
//DOMTest($nodes, $subnodes);

$end = microtime(true) - $start;
echo "Took " . $end . " ms\n";

1. Test: 1000 Nodes with 100 Subnodes for each Node. (XML Filesize: 1.9MB)

   	SimpleXML	XMLWriter	DOM
   Time	0.48202991485596 ms	0.36775803565979 ms	0.72811722755432 ms
   Memory	0.6109619140625 MB	0.61136627197266 MB	0.6141357421875 MB

   

2. Test: 1000 Nodes with 1000 Subnodes for each Node. (XML Filesize: 20MB)

   	SimpleXML	XMLWriter	DOM
   Time	4.867399930954 ms	3.5637412071228 ms	7.1697089672089 ms
   Memory	0.6109619140625 MB	0.61136627197266 MB	0.6141357421875 MB

   

3. Test: 10000 Nodes with 1000 Subnodes for each Node. (XML Filesize: 199MB)

   	SimpleXML	XMLWriter	DOM
   Time	129.83511686325 ms	38.820327997208 ms	365.01518082619 ms
   Memory	0.6109619140625 MB	0.61136627197266 MB	0.6141357421875 MB

   

• Memory Usage: There isn’t a big difference between the three methods in Memory Usage (~0.002 MB)

  

After this Tests, we can see that DOM is not an optimal method for XML generation. DOM with small files needs +0.40 seconds more then XMLWriter, and SimpleXML needs only +0.08 seconds more.

With bigger files, XMLWriter is much faster than the other two methods. So if you need to create big XML files, the best solution is XMLWriter

#!/bin/bash

###### CONFIG ######
ZENDPATH="/opt/ZendStudio/ZendStudio"
USERNAME="Marco Neumann"
USERMAIL="webcoder_at_binware_dot_org"
####################

USERSTRING="$USERNAME"
if [ ! -z $USERMAIL ]; then
    USERSTRING="$USERSTRING <$USERMAIL>"
fi

$ZENDPATH -vmargs -Duser.name="$USERSTRING"

Now ZendStudio will replace the variable ${user} in your Code templates with Marco Neumann <webcoder_at_binware_dot_org>

Here is an example for “Simple php file” in ZendStudio (You will find it in ZendStudio under Window/Preferences/PHP/Code Style):

• Code Template

<?php
/**
 * File for the class ${file}
 *
 * @category   CATEGORY
 * @package    PACKAGE
 * @subpackage SUBPACKAGE
 * @copyright  Copyright (c) ${year} ${user}
 * @author     ${user}
 * @version    $$Id:$$
 */

/**
 * SHORT_DESCRIPTION
 *
 * LONG DESCRIPTION
 *
 * @category   CATEGORY
 * @package    PACKAGE
 * @subpackage SUBPACKAGE
 * @copyright  Copyright (c) ${year} ${user}
 */
${cursor}

• Ouput

<?php
/**
 * File for the class test.php
 *
 * @category   CATEGORY
 * @package    PACKAGE
 * @subpackage SUBPACKAGE
 * @copyright  Copyright (c) 2011 Marco Neumann <webcoder_at_binware_dot_org>
 * @author     Marco Neumann <webcoder_at_binware_dot_org>
 * @version    $Id:$
 */

/**
 * SHORT_DESCRIPTION
 *
 * LONG DESCRIPTION
 *
 * @category   CATEGORY
 * @package    PACKAGE
 * @subpackage SUBPACKAGE
 * @copyright  Copyright (c) 2011 Marco Neumann <webcoder_at_binware_dot_org>
 */

This also works with Eclipse and I think it would also work with Netbeans, but haven’t tested it.

Im using Sharedaddy, and I will not install another extra plugin to support Google +1 and the Sharedaddy option to add a custom service is not prepared for dynamic services like this one. That’s because I looked to integrate the service into Sharedaddy avoiding to change to much the plugin.

Sharedaddy is Object Oriented, so its easy to create a new Sevice Class which extends Sharing_Advanced_Source. But to load your class, you need to change some files.

• sharing-sources.php

  To make it dynamic, I created an extra file called sharing-sources-custom.php and load this file from the original Sharedaddy sharing-sources.php:

  // Custom Sharing services
  require_once('sharing-sources-custom.php');
  

• sharing-services.php

  This file has an array with the current services and the class name for this service, here we must change directly the function to add our new class.

  private function get_all_services() {
  // Default services
  $services = array(
  ...
  'googleplusone' => 'Share_GooglePlusOne'
  );
  

This two changes are enought to get your new service working, if you want you can also add images and edit admin-sharing.css to have preview in your admin panel, but the Service will be working without this.

Here is the Code for the Share_GooglePlusOne class:

<?php
/**
 * File for Custom Services
 *
 * @category WordPress
 * @package  Sharedaddy
 */

/**
 * Class for Google+1
 *
 * Implementeation of Google+1 Service for Sharedaddy
 *
 * @category WordPress
 * @package  Sharedaddy
 * @author Marco Neumann <webcoder_at_binware_dot_org>
 * @copyright Copyright (c) 2011, Marco Neumann
 * Licensed under the GNU GPLv3.
 *
 */
class Share_GooglePlusOne extends Sharing_Advanced_Source
{
    /**
     * Button Size
     *
     * @var String
     */
    private $_size = 'small';

    /**
     * Button Language
     *
     * @var String
     */
    private $_language = 'en-US';

    /**
     * Button with count?
     *
     * @var String
     */
    private $_count = 'true';

    // Configuration extracted from http://code.google.com/apis/+1button/#configuration
    /**
     * Available sizes
     *
     * @var Array
     */
    private $_optionsSize = array(
        'small'    => 'Small Size',
        'medium'   => 'Medium Size',
        'standard' => 'Standard Size',
        'tall'     => 'Tall Size'
    );

    /**
     * Available languages
     *
     * @var Array
     */
    private $_optionsLanguage = array(
        'ar'     => 'Arabic',
        'bg'     => 'Bulgarian',
        'ca'     => 'Catalan',
        'zh-CN'  => 'Chinese (Simplified)',
        'zh-TW'  => 'Chinese (Traditional)',
        'hr'     => 'Croatian',
        'cs'     => 'Czech',
        'da'     => 'Danish',
        'nl'     => 'Dutch',
        'en-GB'  => 'English (UK)',
        'en-US'  => 'English (US)',
        'et'     => 'Estonian',
        'fil'    => 'Filipino',
        'fi'     => 'Finnish',
        'fr'     => 'French',
        'de'     => 'German',
        'el'     => 'Greek',
        'iw'     => 'Hebrew',
        'hi'     => 'Hindi',
        'hu'     => 'Hungarian',
        'id'     => 'Indonesian',
        'it'     => 'Italian',
        'ja'     => 'Japanese',
        'ko'     => 'Korean',
        'lv'     => 'Latvian',
        'lt'     => 'Lithuanian',
        'ms'     => 'Malay',
        'no'     => 'Norwegian',
        'fa'     => 'Persian',
        'pl'     => 'Polish',
        'pt-BR'  => 'Portuguese (Brazil)',
        'pt-PT'  => 'Portuguese (Portugal)',
        'ro'     => 'Romanian',
        'ru'     => 'Russian',
        'sr'     => 'Serbian',
        'sk'     => 'Slovak',
        'sl'     => 'Slovenian',
        'es'     => 'Spanish',
        'es-419' => 'Spanish (Latin America)',
        'sv'     => 'Swedish',
        'th'     => 'Thai',
        'tr'     => 'Turkish',
        'uk'     => 'Ukrainian',
        'vi'     => 'Vietnamese'
    );

    /**
     * Constructor
     *
     * @param Integer $id
     * @param Array $settings
     */
    public function __construct($id, array $settings)
    {
        parent::__construct($id, $settings);

        if (isset($settings['size'])) {
            $this->_size = $settings['size'];
        }
        if (isset($settings['language'])) {
            $this->_language = $settings['language'];
        }
        if (isset($settings['count'])) {
            $this->_count = $settings['count'];
        }
    }

    /**
     * Get Service Name
     *
     * @return String
     */
    public function get_name()
    {
        return __('Google +1', 'sharedaddy');
    }

    /**
     * Displays preview
     *
     * @return Share_GooglePlusOne
     */
    public function display_preview()
    {
?>
    <div class="option option-smart-<?php echo $this->_count; ?>">
        <?php
            if ($this->button_style == 'text' || $this->button_style == 'icon-text') {
                echo $this->get_name();
            } else {
               echo '&nbsp;';
            }
        ?>
    </div>
<?php

        return $this;
    }    

    /**
     * Loads Service required footer code
     *
     * @return Share_GooglePlusOne
     */
    public function display_footer()
    {
        // Load JS for Google +1
        global $post;

        if (isset($post->ID) && $post->ID > 0) {
            $options = array(
                'lang' => $this->_language
            );

            echo '<script type="text/javascript">';
            if (!empty($options)) {
                echo 'window.___gcfg = ' . json_encode($options) .';';
            }
            echo '(function() {
                  var po = document.createElement(\'script\'); po.type = \'text/javascript\'; po.async = true;
                  po.src = \'https://apis.google.com/js/plusone.js\';
                  var s = document.getElementsByTagName(\'script\')[0]; s.parentNode.insertBefore(po, s);
                  })();';
            echo '</script>';
        }

        return $this;
    }

    /**
     * Shows icon
     *
     * @return String
     */
    public function get_display($post)
    {
        return '<g:plusone size="' . $this->_size . '" count="' . $this->_count . '" href="' . get_permalink() . '"></g:plusone>';
    }

    /**
     * Displays available Service options
     *
     * @return Share_GooglePlusOne
     */
    public function display_options()
    {
?>
<div class="input">
    <label>
        <select name="size">
            <?php foreach ($this->_optionsSize as $value=>$name): ?>
                <option value="<?php echo $value; ?>"<?php if ($this->_size == $value): ?> selected="selected"<?php endif; ?>><?php _e($name, 'sharedaddy'); ?>
            <?php endforeach; ?>
        </select>
    </label>
    <label>
        <select name="language">
            <?php foreach ($this->_optionsLanguage as $value=>$name): ?>
                <option value="<?php echo $value; ?>"<?php if ($this->_language == $value): ?> selected="selected"<?php endif; ?>><?php _e($name, 'sharedaddy'); ?>
            <?php endforeach; ?>
        </select>
    </label>
    <label>
        <input type="checkbox"<?php if ($this->_count == 'true') { echo ' checked="checked"'; } ?> name="count" /> Show Count
    </label>
</div>
<?php

        return $this;
    }

    /**
     * Updates submitted options
     *
     * @return Share_GooglePlusOne
     */
    public function update_options(array $data)
    {
        if (isset($data['size']) && isset($this->_optionsSize[$data['size']])) {
            $this->_size = $data['size'];
        }

        if (isset($data['language']) && isset($this->_optionsLanguage[$data['language']])) {
            $this->_language = $data['language'];
        }

        $this->_count = ($data['count'])?'true':'false';

        return $this;
    }

    /**
     * Returns current options
     *
     * @var Array
     */
    public function get_options()
    {
        return array(
            'size'     => $this->_size,
            'language' => $this->_language,
            'count'    => $this->_count
        );
    }
}

Here you can download this file were you will find a patch for the actual sharedaddy version and the images for the admin panel. You only need to apply patch on wp-content/plugins/sharedaddy/ and copy the images to wp-content/plugins/sharedaddy/images/

• Patches
• Sharedaddy with Google +1 – v.1.0
• Sharedaddy with Google +1 – v.1.1 (Added permalink to +1 button – Thanks to megazone)
• Sharedaddy with Google +1 – v.1.2 (Asynchronous Javascript Loading)

• Complete downloads
• Sharedaddy 0.2.12 with Google +1 – v.1.1
• Sharedaddy 0.2.12 with Google +1 – v.1.2

Here is a comparison of Redmine/ChiliProject and Trac features:

The first thing that made me not to test Redmine/ChiliProject immediately was that it is RoR and the complexity to make it run stable under apache, but after searching a bit, I found Phusion Passenger and Ruby Enterprise, which is a very good solution to run RoR products stable under Apache, and you have the ability to run Ruby with custom user, usefull for shared environments.

Installation

1. Ruby Enterprise

   I downloaded and installer from source code, so that it’s compiled for my server and I can store it in a specific location. So, the first we have to do is download latest version from Ruby Enterprise Download page

   wget http://rubyenterpriseedition.googlecode.com/files/ruby-enterprise-1.8.7-2011.03.tar.gz
   tar zxvf ruby-enterprise-1.8.7-2011.03.tar.gz
   cd ruby-enterprise-1.8.7-2011.03
   ./installer

   Follow installer instructions, and install dependencies if needed (the installer tells us which packages we need for our Linux distro)

2. Phusion Passenger

   Next thing to do, is install the Passanger module for apache, this can be done with the passenger-install-apache2-module script available at Ruby Enterprise installation

   cd /opt/ruby-enterprise-1.8.7-2011.03/bin
   ./passenger-install-apache2-module

   This script also checks the dependencies and says what packages you need for your Linux distro

3. Apache

   Now we need to configure apache, first we need to activate and configure the passenger module

   /etc/apache2/mods-enabled/passenger.load

   LoadModule passenger_module /opt/ruby-enterprise-1.8.7-2011.03/lib/ruby/gems/1.8/gems/passenger-3.0.7/ext/apache2/mod_passenger.so

   /etc/apache2/mods-enabled/passenger.conf

   <ifmodule mod_passenger.c>
     PassengerRoot /opt/ruby-enterprise-1.8.7-2011.03/lib/ruby/gems/1.8/gems/passenger-3.0.7
     PassengerRuby /opt/ruby-enterprise-1.8.7-2011.03/bin/ruby
    
     PassengerFriendlyErrorPages Off
     PassengerUserSwitching On
     PassengerDefaultUser www-data
     PassengerDefaultGroup www-data
   </ifmodule>

   And the last thing is configure a vhost under which we will run this ChiliProject installation

   /etc/apache2/sites-enabled/chiliproject

   NameVirtualHost *:443
   <virtualhost *:443>
   	SSLEngine on
    
   	SSLCertificateFile    /etc/apache2/ssl/server.crt
   	SSLCertificateKeyFile /etc/apache2/ssl/server.key
    
   	<ifmodule mod_passenger.c>
   		PassengerUser chiliproject
   		PassengerGroup chiliproject
   	</ifmodule>
    
           ServerAdmin webmaster@chiliproject.org
   	ServerName chiliproject.org
    
   	DocumentRoot /home/chiliproject/public
   	<directory />
   		Options -MultiViews
   		AllowOverride All
   	< /Directory>
    
   	ErrorLog /var/log/apache2/chiliproject-error.log
    
   	CustomLog /var/log/apache2/chiliproject-access.log combined
   </virtualhost>

4. ChiliProject

   First install needed gems

   /opt/ruby-enterprise-1.8.7-2011.03/bin/gem install -v=0.4.2 i18n
   /opt/ruby-enterprise-1.8.7-2011.03/bin/gem install -v=1.0.1 rack
   /opt/ruby-enterprise-1.8.7-2011.03/bin/gem install mysql

   Download the last available ChiliProject version from ChiliProject Files Page

   wget https://www.chiliproject.org/attachments/download/99/chiliproject-1.4.0.tar.gz
   tar zxvf chiliproject-1.4.0.tar.gz
   mv chiliproject-1.4.0 /home/chiliproject

   Create the mysql database and user for ChiliProject

   CREATE DATABASE chiliproject CHARACTER SET utf8 COLLATE utf8_unicode_ci;
   GRANT ALL privileges ON chiliproject.* TO 'chiliproject'@'localhost' IDENTIFIED BY 'my_password';

   Configure ChiliProject Database Connection

   mv config/database.yml.example config/database.yml

   production:
     adapter: mysql
     database: chiliproject
     host: localhost
     username: chiliproject
     password: my_password

   Now initialize ChiliProject (session Store, DB Tables, DB Default Data

   /opt/ruby-enterprise-1.8.7-2011.03/bin/rake generate_session_store
   RAILS_ENV=production /opt/ruby-enterprise-1.8.7-2011.03/bin/rake db:migrate
   RAILS_ENV=production /opt/ruby-enterprise-1.8.7-2011.03/bin/rake redmine:load_default_data

   And the last thing we need to do before we can restart apache and begin to use the new installed ChiliProject, we need to create the chiliproject user

   adduser --home /home/chiliproject --shell /bin/false --no-create-home chiliproject
   chown -R chiliproject:chiliproject /home/chiliproject

5. (Optinal) Rmagick

   If we would like to enable Gantt export to png image we need to install Rmagick (available as gem). First we need to install imagemagick ang graphicsmagick dev packages and then we can install the rmagick gem.

   apt-get install libmagickcore-dev libgraphicsmagick1-dev libmagickwand-dev
   /opt/ruby-enterprise-1.8.7-2011.03/bin/gem install rmagick

Now we only need to restart Apache and load ChiliProject in our Browser. The default user is admin/admin

Memcached has Pages that have a size of 1Mb (in newer version you can configure them from 1Mb to 128Mb), these Pages are divided in Chunks. The size of the Chunks is created dynamically after start, depending on the size of the Objects you are saving. Memcached tries to save a Object in a Chunk were the basted space is minimal (An 49Kb Object will be saved in an 50Kb Chunk)

These behavior is ok, but it’s a Problem when you change the size of your Objects, because Memcached doesn’t recalculate the Chunk Size, he will use the Chunk Size that is available and because of that the available Memory will not used optimally.

An Example:

• We start Memcached and save 5-50Kb Objects, so the Chunks will take an Size of 5-50Kb and for bigger Objects there would be only one or two Pages available.
• We change our Objects and we want to save 500Kb Objects. Memcached only has for this Object size one or two Pages available, and therefore this big Objects will be soon Evicted, because we have Space for maximum 2x500Kb for each Page. That means if we have 2 Pages with 500Kb Chunks, we can save 4 500Kb Objects, but if we save a fifth element it will cause that the first Object we saved is Evicted.

This behavior will cause that the small and big Objects will be saved correctly in Memcached, but when we try to get the entry from cache, it could happen we only have the small Objects in cache and the big Objects are not available.

Here an example with 300 seconds lifetime:

Item count:  2
Chunk Size (max item size): 448.2 KBytes
Chunks Per Page (items per 1MB): 2
Pages Allocated: 1
Total Chunks (capacity): 2
Used Chunks (capacity): 2
Free Chunks (free capacity): 0
Evicted: 1172130
Age: 1 minute

Items: item
1968214dc63043688cf883c794c118ecc29e6
19682_039f86925e86b5a3da4cff58c252dff4

After 1 minute the Objects are not available and we have two new Objects:

Item count:  2
Chunk Size (max item size): 448.2 KBytes
Chunks Per Page (items per 1MB): 2
Pages Allocated: 1
Total Chunks (capacity): 2
Used Chunks (capacity): 2
Free Chunks (free capacity): 0
Evicted: 1172133
Age: 0 minutes

Items: item
19682_63de2d8620816234fd044ca48c0578bd
19682_f86a0ea59a264a397233232a20a080f4

Unfortunately it seems that the actual version 1.4.5 doesn’t have rebalancing implemented, so if you change your cache Object size you must restart your Memcached instance (a flush will not help you).

Here two Screenshots were we can appreciate this behavior.

Only small Objects:

After restart with small and big Objects:

• Statistics Tool with pages/chunk Detail:
• First version of memcache stats script based on memcache.php
• Memcached Pages/Chunk information:
• Evictions and memory setup for memcache
• MemCached Evictions

In Debian we have a package called spidermonkey-bin.

apt-get install spidermonkey-bin

After installing you will have a program called smjs.

If you start the program without parameters you will get a Javascript shell, in which you can write and test javascript.

$ /usr/bin/smjs
js> function test() {
print('test');
}
js> test
function test() {
    print("test");
}
js> test();
test
js> function test() {
print('test');
test2(123);
}
js> function test2(param) {
print ('test2: ' + param);
}
js> test();
test
test2: 123
js>

To exit the shell, just press “Ctrl+D“.

It’s important to note that in spidermonkey you doesn’t have the “document” Object. If you want to print out text, you cant use document.write, you should use print.

document.write('test'); // In browser
print('test'); //spidermonkey

You can also make smjs to execute the content of a file.

$ /usr/bin/smjs test-local.js
Rand: 407
Old: 600
New: 800
Result: old

First of all we need to install needed packages

apt-get install libapache2-mod-wsgi python-virtualenv python-setuptools

Once we have installed the required packages proceed to create the Python environment

mkdir /usr/local/trac
cd /usr/local/trac
virtualenv python

We now have the isolated Python environment locate under /usr/local/trac/python.

To make possible to use easy_install with repositories we need to upgrade easy_install. I use this to install Trac plugins directly from SVN.

/usr/local/trac/python/bin/easy_install -U trunk

We now can install trac 0.12 using the 0.12b1 SVN Tag (http://svn.edgewall.com/repos/trac/tags/trac-0.12b1 or Trac==0.12b1) or directly from SVN Trunk:

/usr/local/trac/python/bin/easy_install http://svn.edgewall.org/repos/trac/trunk

This will download and install the latest trunk version for Trac.

To have webaccess to the Trac projects, we need a .wsgi script, were we define where our local python environment is located:

# Not needed if mod_wsgi >= 3.0
import sys
sys.stdout = sys.stderr
 
# Load Trac
import trac.web.main
application = trac.web.main.dispatch_request

And finally we need to configure apache. If you want only one Trac project, you should define trac.env to the location of your trac, but if you want multiproject support, you must use trac.env_parent_dir (this is what I used)

<virtualhost *:80>
    ServerName trac.dns.com
 
    DocumentRoot /usr/local/trac/htdocs
    ErrorLog /var/log/apache2/trac-error.log
    CustomLog /var/log/apache2/trac-access.log combined
 
    # Trac Auth
    <location />
        AuthType Basic
        AuthName "Trac"
        AuthUserFile /usr/local/trac/.htpasswd
        Require valid-user
    < /location>
 
    #Trac
    #Define ProcessGroup with user and group under which it should run
    WSGIDaemonProcess trac user=trac group=trac python-path=/usr/local/trac/python/lib/python2.5/site-packages python-eggs=/usr/local/trac/python/cache
    WSGIScriptAlias / /usr/local/trac/htdocs/trac.wsgi
 
    <directory /usr/local/trac/htdocs>
        WSGIProcessGroup trac
        WSGIApplicationGroup %{GLOBAL}
        SetEnv trac.env_parent_dir /usr/local/trac/projects
    </directory>
</virtualhost>

We need to create the user and change the permissions for /usr/local/trac for that user trac

adduser --home /usr/local/trac --shell /bin/false --no-create-home trac
chown -R trac:trac /usr/local/trac

If you get an error “ImportError: No module named simplejson” just install it using easy_install

/usr/local/trac/python/bin/easy_install simplejson

Netbeans is not perfect, and there are some features that need to be polished (Ex.: SVN Support, Time Tracking like Mylyn), but the PHP/HTML/CSS/JS Support is excellent, in my opinion better than the Eclipse PDF support.

These is my netbeans_default_options for Netbeans for MacOSX (under Windows you can leave out the –laf switch, it’s for changing the look and feel):

netbeans_default_options="-J-client -J-Xss2m -J-Xms32m -J-Xmx512m -J-XX:PermSize=32m -J-XX:MaxPermSize=200m -J-Xverify:none -J-XX:CompileThreshold=100 -XX:+CompressedOOPS -XX:+AggressiveOpts -XX:+TieredCompilation -XX:+DoEscapeAnalysis -XX:+UseConcMarkSweepGC -J-XX:+CMSClassUnloadingEnabled -J-XX:+CMSPermGenSweepingEnabled -J-Dapple.laf.useScreenMenuBar=true -J-Dsun.java2d.noddraw=true --laf javax.swing.plaf.metal.MetalLookAndFeel"

Some switches come from Netbeans Performance site.

• -J-Xss2m – Define Stack Size (Too small and you will get StackOverflow Exceptions)
• -J-Xms32m – This setting tells the Java virtual machine to set its initial heap size to 32 megabytes. By telling the JVM how much memory it should initially allocate for the heap, we save it growing the heap as NetBeans consumes more memory. This switch improves startup time
• -J-Xmx512m – This settings tells the Java virtual machine the maximum amount of memory it should use for the heap. Placing a hard upper limit on this number means that the Java process cannot consume more memory than physical RAM available. This limit can be raised on systems with more memory. Current default value is 128MB. Note: Do not set this value to near or greater than the amount of physical RAM in your system or it will cause severe swapping during runtime
• -J-XX:PermSize=32m -J-XX:MaxPermSize=200m – How much Heap can be added over the Xmx limit
• -J-Xverify:none – This switch turns off Java bytecode verification, making classloading faster, and eliminating the need for classes to be loaded during startup solely for the purposes of verification. This switch improves startup time, and there is no reason not to use it
• -J-XX:CompileThreshold=100 – This switch will make startup time slower, by HotSpot to compile many more methods down to native code sooner than it otherwise would. The reported result is snappier performance once the IDE is running, since more of the UI code will be compiled rather than interpreted. This value represents the number of times a method must be called before it will be compiled
• -XX:+CompressedOOPS – Activate Compressed “Ordinary Object Pointer”
• -XX:+AggressiveOpts – Turns on point performance optimizations that are expected to be on by default in upcoming releases
• -XX:+TieredCompilation – Activate Tiered Compiler
• -XX:+DoEscapeAnalysis – Activate Escape Analysis
• -J-XX:+UseConcMarkSweepGC or -J-XX:+UseParNewGC Try these switches if you are having problems with intrusive garbage collection pauses. This switch causes the JVM to use different algorithms for major garbage collection events (also for minor collections, if run on a multiprocessor workstation), ones which do not “stop the world” for the entire garbage collection process. You should also add the line -J-XX:+CMSClassUnloadingEnabled and -J-XX:+CMSPermGenSweepingEnabled to your netbeans.conf file so that class unloading is enabled (it isn’t by default when using this collector)