UserProfilesPlugin.php

<?php

define('USER_PROFILES_DIR', dirname(__FILE__) );
require_once(USER_PROFILES_DIR . '/helpers/functions.php');
class UserProfilesPlugin extends Omeka_Plugin_AbstractPlugin
{

    protected $_hooks = array(
        'install',
        'uninstall',
        'define_acl',
        'config',
        'config_form',
        'admin_items_show_sidebar',
        'public_items_show',
        'public_content_top',
        'admin_users_browse_each',
        'after_delete_user',
        'initialize',
        'upgrade',
        );

    protected $_filters = array(
            'admin_navigation_main',
            'search_record_types',
            'api_resources',
            'api_import_omeka_adapters'
            );

    protected $_options = null;

    public function setUp()
    {
        if(plugin_is_active('GuestUser')) {
            $this->_filters[] = 'guest_user_links';
        }
        parent::setUp();
    }

    public function hookInitialize()
    {
        add_translation_source(dirname(__FILE__) . '/languages');
    }

    public function hookUpgrade($args)
    {
        $db = get_db();
        $old = $args['old_version'];
        $new = $args['new_version'];

        if (version_compare($old, '1.1.1', '<')) {
            $sql = "
                ALTER TABLE `$db->UserProfilesProfile` CHANGE  `modified` `modified` TIMESTAMP ON UPDATE CURRENT_TIMESTAMP NOT NULL DEFAULT '2000-01-01 00:00:00', CHANGE  `added` `added` TIMESTAMP NOT NULL DEFAULT '2000-01-01 00:00:00'
            ";
            $db->query($sql);
        }
    }
    
    public function hookInstall()
    {
        $db = get_db();
        $sql = "
            CREATE TABLE IF NOT EXISTS `$db->UserProfilesProfile` (
                `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
                `type_id` int(10) unsigned NOT NULL ,
                `owner_id` int(10) unsigned NOT NULL ,
                `added` timestamp NOT NULL DEFAULT '2000-01-01 00:00:00',
                `modified` timestamp NOT NULL DEFAULT '2000-01-01 00:00:00' ON UPDATE CURRENT_TIMESTAMP,
                `public` tinyint(1) NOT NULL,
                PRIMARY KEY (`id`)
            ) ENGINE=MyISAM DEFAULT CHARSET=utf8;";
        $db->query($sql);

        $sql = "
            CREATE TABLE IF NOT EXISTS `$db->UserProfilesType` (
                `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
                `label` text,
                `description` text,
    			`element_set_id` int(10) unsigned NOT NULL,
    			`required_element_ids` text NOT NULL,
                `required_multielement_ids` text NOT NULL,
                `public` tinyint(1) NOT NULL,
                `required` tinyint(1) NOT NULL,
                PRIMARY KEY (`id`)
            ) ENGINE=MyISAM DEFAULT CHARSET=utf8;";
        $db->query($sql);

        $sql = "
            CREATE TABLE IF NOT EXISTS `$db->UserProfilesMultiElement` (
              `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
              `name` text COLLATE utf8_unicode_ci NOT NULL,
              `description` text COLLATE utf8_unicode_ci NOT NULL,
              `type` enum('radio','select','multiselect','checkbox') COLLATE utf8_unicode_ci NOT NULL,
              `options` text COLLATE utf8_unicode_ci NOT NULL,
              `element_set_id` int(10) unsigned NOT NULL,
              `order` int(11) DEFAULT NULL,
              `comment` text COLLATE utf8_unicode_ci,
              PRIMARY KEY (`id`)
            ) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='A parallel to Elements for checkboxes, radio, selects ' ;
        ";

        $db->query($sql);

        $sql = "
            CREATE TABLE IF NOT EXISTS `$db->UserProfilesMultiValue` (
              `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
              `profile_type_id` int(10) unsigned NOT NULL,
              `profile_id` int(10) unsigned NOT NULL,
              `values` text COLLATE utf8_unicode_ci NOT NULL,
              `multi_id` int(10) unsigned NOT NULL,
              PRIMARY KEY (`id`)
            ) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci  ;
        ";
        $db->query($sql);
        set_option('user_profiles_required_elements', serialize(array()));
        set_option('user_profiles_required_multielements', serialize(array()));
        $plugin = get_db()->getTable('Plugin')->findByDirectoryName('Contribution');
        if($plugin) {
            set_option('user_profiles_contributors_imported', 0);
        }
    }

    public function hookUninstall()
    {
        $db = get_db();
        //Delete all elements, elementsets, and elementtexts UP is using
        $types = $db->getTable('UserProfilesType')->findAll();
        foreach($types as $type) {
            $type->getElementSet()->delete();
        }
        $sql = "DROP TABLE IF EXISTS `$db->UserProfilesProfile` ";
        $db->query($sql);

        $sql = "DROP TABLE IF EXISTS `$db->UserProfilesType` ";
        $db->query($sql);

        $sql = "DROP TABLE IF EXISTS `$db->UserProfilesMultiValue` ";
        $db->query($sql);

        $sql = "DROP TABLE IF EXISTS `$db->UserProfilesMultiElement` ";
        $db->query($sql);

        //don't forget to delete the record relations
        $sql = "DELETE FROM `$db->RecordRelationsRelation` WHERE `object_record_type` = 'UserProfilesProfile'" ;
        $db->query($sql);
    }

    public function hookAfterDeleteUser($args)
    {
        $user = $args['record'];
        $profiles = get_db()->getTable('UserProfilesProfile')->findByUserId($user->id);
        foreach($profiles as $profile) {
            $profile->deleteWithRelation();
        }
    }

    public function filterAdminNavigationMain($tabs)
    {
        $tabs['User Profiles'] = array('label'=>'User Profiles', 'uri'=>url("user-profiles") );
        return $tabs;
    }

    public function filterGuestUserLinks($links)
    {
        $user = current_user();
        $typesTable = $this->_db->getTable('UserProfilesType');
        $incompleteTypes = $typesTable->getIncompleteProfileTypes();
        if(!empty($incompleteTypes)) {
            $type = $incompleteTypes[0];
            $links['UserProfiles'] = array('label'=>'My Profiles', 'uri'=>url("/user-profiles/profiles/user/id/{$user->id}/type/{$type->id}"));
            return $links;
        }

        $firstProfileTypes = $this->_db->getTable('UserProfilesType')->findBy(array(), 1);
        if(!empty($firstProfileTypes)) {
            $type = $firstProfileTypes[0];
            $links['UserProfiles'] = array('label'=>'My Profiles', 'uri'=>url("/user-profiles/profiles/user/id/{$user->id}/type/{$type->id}"));
        }
        return $links;
    }

    public function filterSearchRecordTypes($recordTypes)
    {
        $recordTypes['UserProfilesProfile'] = __('User Profiles');
        return $recordTypes;
    }
    
    public function filterApiResources($resources)
    {
        $resources['user_profiles_types'] = array(
                'record_type' => 'UserProfilesType',
                'actions'     => array('index', 'get')
                );
        $resources['user_profiles'] = array(
                'record_type' => 'UserProfilesProfile',
                'actions'     => array('index', 'get')
                );
        $resources['user_profiles_multielements'] = array(
                'record_type' => 'UserProfilesMultiElement',
                'actions'     => array('index', 'get'),
                );
        $resources['user_profiles_multivalues'] = array(
                'record_type' => 'UserProfilesMultiValue',
                'actions'     => array('index', 'get')
                );
        return $resources;
    }

    public function filterApiImportOmekaAdapters($adapters, $args)
    {
        // Sequence is important here. Need the types and their elements mapped in first
        // Then the profiles themselves, then bring in the multi-valued elements then their values
        $typesAdapter = new ApiImport_ResponseAdapter_Omeka_GenericAdapter(null, $args['endpointUri'], 'UserProfilesType');
        $typesAdapter->setResourceProperties(array('element_set' => 'ElementSet'));
        $adapters['user_profiles_types'] = $typesAdapter;
        $elementAdapter = new ApiImport_ResponseAdapter_Omeka_UserProfilesMulti(null, $args['endpointUri'], 'UserProfilesMultiElement');
        $elementAdapter->setResourceProperties(array('element_set' => 'ElementSet'));
        $adapters['user_profiles_multielements'] = $elementAdapter;
        $profileAdapter = new ApiImport_ResponseAdapter_Omeka_UserProfilesProfile(null, $args['endpointUri'], 'UserProfilesProfile');
        $adapters['user_profiles'] = $profileAdapter; 

        $valueAdapter = new ApiImport_ResponseAdapter_Omeka_UserProfilesMulti(null, $args['endpointUri'], 'UserProfilesMultiValue');
        $valueAdapter->setResourceProperties(array(
                'profile_type' => 'UserProfilesType',
                'multi'        => 'UserProfilesMultiElement',
                'profile'      => 'UserProfilesProfile'
                ));
        $adapters['user_profiles_multivalues'] = $valueAdapter;
        return $adapters;
    }

    public function hookPublicItemsShow($args)
    {
        if(get_option('user_profiles_link_to_owner')) {
            $view = $args['view'];
            $view->addHelperPath(USER_PROFILES_DIR . '/helpers', 'UserProfiles_View_Helper_');
            echo $view->linkToOwnerProfile(array('item' =>$args['item'], 'text'=> __("Added by ")));
        }
    }

    public function hookPublicContentTop($args)
    {
        $request = Zend_Controller_Front::getInstance()->getRequest();
        $module = $request->getModuleName();
        $action = $request->getActionName();
        //check if they are already editing a profile, and if so don't ask them to edit a profile
        if($module == 'user-profiles' && ($action == 'user' || $action == 'edit')) {
            return;
        }
        $view = $args['view'];
        $view->addHelperPath(USER_PROFILES_DIR . '/helpers', 'UserProfiles_View_Helper_');

        echo $view->linksToIncompleteProfiles();
    }

    public function hookAdminUsersBrowseEach($args)
    {
        $user = $args['user'];
        $view = $args['view'];
        $view->addHelperPath(USER_PROFILES_DIR . '/helpers', 'UserProfiles_View_Helper_');
        echo $view->linkToOwnerProfile(array('owner'=>$user,  'text'=>"Profile: "));
    }

    public function hookAdminItemsShowSidebar($args)
    {
        if(get_option('user_profiles_link_to_owner')) {
            $view = $args['view'];
            echo "<div class='panel'>";
            echo "<h4>Owner Info</h4>";
            $view->addHelperPath(USER_PROFILES_DIR . '/helpers', 'UserProfiles_View_Helper_');
            echo $view->linkToOwnerProfile(array('item' =>$args['item']));
            echo "</div>";
        }
    }

    public function hookConfig($args)
    {
       $db = get_db();
       $post = $args['post'];
       foreach($post as $option=>$value) {
           set_option($option, $value);
       }
       if($post['user_profiles_import_contributors'] == 1) {
           $importer = new UserProfilesImportContribution(array());
           $importer->perform();
       }
    }

    public function hookConfigForm($args)
    {
        include(USER_PROFILES_DIR . '/config_form.php');
    }

    public function hookDefineAcl($args)
    {
        $acl = $args['acl'];
        $acl->addResource('UserProfiles_Type');
        $acl->addResource('UserProfiles_Profile');

        //null as 1st param in allow includes not logged in, so manage roles here
        $roles = array('super', 'admin', 'contributor', 'researcher');
        if(plugin_is_active('GuestUser')) {
            $roles[] = 'guest';
        }

        $acl->allow(null,
                'UserProfiles_Profile',
                array('edit', 'delete'),
                new Omeka_Acl_Assert_Ownership);

        $acl->allow(null, 'UserProfiles_Profile', array('user'));
        $acl->allow($roles, 'UserProfiles_Profile', array('add', 'editSelf', 'delete-confirm', 'showSelfNotPublic', 'deleteSelf'));

        $acl->allow(array('admin', 'super', 'researcher'), 'UserProfiles_Profile', array('showNotPublic'));
        $acl->allow(array('admin', 'super'), 'UserProfiles_Profile', array('deleteAll'));
        $acl->deny(null, 'UserProfiles_Type');
        $acl->allow(array('super', 'admin'), 'UserProfiles_Type');
        //let all logged in people see the types available, but hide non-public ones from searches
        //since public/private is managed by Omeka_Db_Select_PublicPermission, this keeps them out of the navigation
        $acl->allow($roles, 'UserProfiles_Type', array('showNotPublic'));
    }
}