BEdita API doc | 4-cactus
  • Class
  • Tree
  • Deprecated
  • Download

Classes

  • Addon
  • AddressbookController
  • AddressbookShell
  • AdminController
  • Alias
  • Annotation
  • ApiAuthComponent
  • ApiBaseController
  • ApiFormatterComponent
  • ApiUploadComponent
  • ApiValidatorComponent
  • AppController
  • AppError
  • AppHelper
  • Application
  • AppModel
  • Area
  • AreasController
  • Audio
  • AuthenticationsController
  • BannedIp
  • BEAppModel
  • BEAppObjectModel
  • BeAuthComponent
  • BeAuthFacebookComponent
  • BeAuthGoogleComponent
  • BeAuthTwitterComponent
  • BeCallbackManager
  • BeConfigure
  • BeCustomPropertyComponent
  • BeditaAnnotationModel
  • BeditaBaseShell
  • BeditaCollectionModel
  • BeditaContentModel
  • BeditaExportFilter
  • BeditaImportFilter
  • BeditaObjectModel
  • BeditaProductModel
  • BeditaShell
  • BeditaSimpleObjectModel
  • BeditaSimpleStreamModel
  • BeditaStreamModel
  • BeEmbedFlashHelper
  • BeEmbedHtml5Helper
  • BeEmbedMediaHelper
  • BeErrorCode
  • BeExceptionHandler
  • BEFile
  • BeFileHandlerComponent
  • BeFormHelper
  • BeFrontHelper
  • BeHashComponent
  • BeHtmlHelper
  • BeLangTextComponent
  • BeLib
  • BeMailComponent
  • BEObject
  • BeObjectCache
  • BePaginatorToolbarHelper
  • BeSchema
  • BeSecurityComponent
  • BeSystem
  • BeSystemComponent
  • BeThumb
  • BeTimeHelper
  • BeToolbarHelper
  • BeTreeComponent
  • BeTreeHelper
  • BeUploadToObjComponent
  • BeurlHelper
  • BeVimeoComponent
  • BeYoutubeComponent
  • BuildFilterBehavior
  • CacheableBehavior
  • CacheShell
  • CallbackBehavior
  • CaptchaComponent
  • Caption
  • CaptionsBehavior
  • Card
  • CardsImportFilter
  • Category
  • CleanupDataTask
  • CleanupTask
  • Comment
  • CommentsController
  • CompactResultBehavior
  • Content
  • CreateIndexFieldsBehavior
  • DataShell
  • DataTransfer
  • DateItem
  • DbadminShell
  • DeleteDependentObjectBehavior
  • DeleteObjectBehavior
  • DeployShell
  • Document
  • DocumentsController
  • DumpModel
  • EditorialContentsShell
  • EditorNote
  • Event
  • EventLog
  • EventsController
  • FilesController
  • ForeignDependenceSaveBehavior
  • FrontendController
  • FrontendShell
  • GalleriesController
  • Gallery
  • GeoTag
  • GettextShell
  • Git
  • GravatarHelper
  • Group
  • HashJob
  • History
  • HomeController
  • Image
  • ImageInfoHelper
  • JsonExportFilter
  • JsonImportFilter
  • JsonView
  • LangText
  • Link
  • MailGroup
  • MailGroupCard
  • MailJob
  • MailLog
  • MailMessage
  • MailShell
  • MailTemplate
  • Mask
  • MediaShell
  • MigrateDumpModel
  • MigrateShell
  • Migration
  • MigrationBase
  • MigrationDateItemsShell
  • Module
  • ModulesController
  • ModuleShell
  • MultimediaController
  • NewsController
  • NewsletterController
  • NewsletterShell
  • NotifyBehavior
  • ObjectEditor
  • ObjectProperty
  • ObjectRelation
  • ObjectType
  • ObjectUser
  • PagesController
  • Permission
  • PermissionModule
  • PermsHelper
  • Product
  • Property
  • PropertyOption
  • PublicationShell
  • RedisShell
  • RelationCheck
  • RelationRepair
  • RelationShell
  • RelationStats
  • RemoveDummyNameBehavior
  • ResponseHandlerComponent
  • RestClientModel
  • Revision
  • RevisionObjectBehavior
  • SearchText
  • SearchTextSaveBehavior
  • Section
  • SectionDummy
  • SessionFilterComponent
  • SessionFilterHelper
  • ShortNews
  • SmartyView
  • SoapClientModel
  • SplitterSql
  • StatisticsController
  • Stream
  • StreamLog
  • StreamsController
  • Svn
  • TagsController
  • ThemeSmartyView
  • ThumbnailHelper
  • ThumbShell
  • TransactionComponent
  • TransactionFS
  • TranslationsController
  • Tree
  • TrHelper
  • User
  • UserProperty
  • UsersController
  • Utility
  • Version
  • Video
  • VimeoHelper
  • WebmarksController
  • XmlExportFilter
  • XmlImportFilter
  • XmlJsonConverter
  • XmlView
  • YoutubeHelper

Interfaces

  • ApiAuthInterface
  • MediaProviderInterface
  • UploadableInterface

Exceptions

  • BeditaAjaxException
  • BEditaAllowURLException
  • BeditaBadRequestException
  • BeditaConflictException
  • BEditaDeleteStreamObjException
  • BeditaException
  • BEditaFileExistException
  • BeditaForbiddenException
  • BeditaFrontAccessException
  • BeditaHashException
  • BEditaInfoException
  • BeditaInternalErrorException
  • BEditaIOException
  • BeditaLengthRequiredException
  • BeditaMailException
  • BEditaMediaProviderException
  • BeditaMethodNotAllowedException
  • BEditaMIMEException
  • BeditaNotFoundException
  • BeditaNotImplementedException
  • BeditaPublicationException
  • BeditaRuntimeException
  • BEditaSaveStreamObjException
  • BeditaServiceUnavailableException
  • BeditaUnauthorizedException
  • BEditaUploadPHPException
  • BEditaURLException
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 
<?php
/*-----8<--------------------------------------------------------------------
 *
 * BEdita - a semantic content management framework
 *
 * Copyright 2015 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 *
 *------------------------------------------------------------------->8-----
 */

require_once 'bedita_base.php';

/**
 * Shell script to import/export/manipulate cards.
 * 
 */
class AddressbookShell extends BeditaBaseShell {

    public function import() {
        if(!isset($this->params['f'])) {
            $this->out('Input file is mandatory');
            return;
        }

        $options = array('mailGroups' => array());
        $mail_group_id = null;
        $mailgroup = ClassRegistry::init('MailGroup');
        if (isset($this->params['m'])) {
            $mail_group_id = $mailgroup->field('id', array('group_name' => $this->params['m']));
            if (empty($mail_group_id)) {
                $this->out('Mail group ' . $this->params['m'] . ' not found: import aborted');
                return false;
            }
            $options['joinGroup'][0]['mail_group_id'] = $mail_group_id;
            $options['joinGroup'][0]['status'] = 'confirmed';
        } else {
            $allMailGroups = $mailgroup->find('all');
            if (!empty($allMailGroups)) {
                foreach ($allMailGroups as $mg) {
                    $options['mailGroups'][$mg['MailGroup']['group_name']] = $mg['MailGroup']['id'];
                }
            }
        }

        $cardFile = $this->params['f'];
        if(!file_exists($cardFile)) {
            $this->out("$cardFile not found, bye");
            return;
        }

        // categories
        if (!isset($this->params['c'])) {
            $this->out('No categories set');
        } else {
            $categories = trim($this->params['c']);
            $catTmp = split(',', $categories);
            $categoryModel = ClassRegistry::init('Category');
            $cardTypeId = Configure::read('objectTypes.card.id');
            $options['Category'] = $categoryModel->findCreateCategories($catTmp, $cardTypeId);
        }

        $ext = strtolower(substr($cardFile, strrpos($cardFile, ".")+1));
        $isCsv = ($ext == 'csv');
        $this->out("Importing file $cardFile using " . (($isCsv) ? 'CSV' : 'VCard') . ' format');
        
        if (isset($this->params['delimiter'])) {
            $options['delimiter'] = $this->params['delimiter'];
            $this->out('Using delimiter: ' . $options['delimiter']);
        }
        if (isset($this->params['overwritePolicy'])) {
            $options['overwritePolicy'] = $this->params['overwritePolicy'];
            $this->out('Using overwritePolicy: ' . $options['overwritePolicy']);
        }
        App::import('Component', 'Transaction');
        $transaction = new TransactionComponent();
        $cardModel = ClassRegistry::init('Card');
        if($isCsv) {
            $result = $cardModel->importCSVFile($cardFile, $options);
        } else {
            $result = $cardModel->importVCardFile($cardFile, $options);
        }
        $this->out('Done');
        $this->out('Result: ' . print_r($result, true));
        $transaction->commit();
    }

    public function export() {
        if (!isset($this->params['f'])) {
           $this->out('Output file is mandatory');
            return;
        }

        $cardFile = $this->params['f'];
        $this->checkExportFile($cardFile);

        $options = array();
        $type = 'vcard'; // default
        if (isset($this->params['t'])) {
            $type = strtolower($this->params['t']);
            if (!in_array($type, array('vcard', 'csv', 'custom'))) {
                $this->out("Unknown type $type");
                return;
            }
            if ($type == 'custom') {
                $options['custom'] = true;
            }
        } else {
            $ext = strtolower(substr($cardFile, strrpos($cardFile, '.')+1));
            if ($ext == 'csv') {
                $type = 'csv';
            }
        }
        $this->out("Exporting to $cardFile using '$type' format");
        if (isset($this->params['delimiter'])) {
            $options['delimiter'] = $this->params['delimiter'];
            $this->out('Using delimiter: ' . $options['delimiter']);
        }
        
        $cardModel = ClassRegistry::init('Card');
        $cardModel->contain();
        $res = $cardModel->find('all', array('fields' => array('id')));
        $handle = fopen($cardFile, 'w');
        if($type !== 'vcard') {
            fwrite($handle, $cardModel->headerCSV($options) . "\n");
        }
        foreach ($res as $r) {
            $cardModel->id = $r['id'];
            if($type !== 'vcard') {
                $str = $cardModel->exportCSV($options);
            } else {
                $str = $cardModel->exportVCard();
            }
            fwrite($handle, $str . "\n");
        }
        fclose($handle);
        $this->out("$cardFile created.");       
    }

    function help() {
        $this->out('Available functions:');
        $this->out(' ');
        $this->out('1. import: import vcf/vcard or microsoft outlook csv file, or custom csv file');
        $this->out(' ');
        $this->out('    Usage: import -f <csv-cardfile> [-c <categories>] [-m <mail-group-name>] [-delimiter <delimiter>] [-overwritePolicy <policy>]' );
        $this->out(' ');
        $this->out("    -f <csv-cardfile>\t vcf/vcard or csv file to import");
        $this->out("    -c <categories> \t comma separated <categories> to use on import (created if not exist)");
        $this->out("    -m <mail-group-name> \t name of mail group to associate with imported cards");
        $this->out("    -delimiter <delimiter> \t CSV delimiter, default is ','");
        $this->out("    -overwritePolicy <policy> \t 'skip'(default), 'overwrite', 'new'");
        $this->out(' ');
        $this->out('2. export: export to vcf/vcard or microsoft outlook csv file');
        $this->out(' ');
        $this->out('    Usage: export -f <csv-cardfile> [-t <type>] [-delimiter <delimiter>]');
        $this->out(' ');
        $this->out("    -f <csv-cardfile>\t vcf/vcard or csv file to export");
        $this->out("    -t <type> \t 'vcard' (default), 'csv' or 'custom'");
        $this->out("    -delimiter <delimiter> \t CSV delimiter, default is ','");
        $this->out(' ');
    }

}
?>
BEdita API doc | 4-cactus API documentation generated by ApiGen