{"id":46,"date":"2016-05-06T08:57:42","date_gmt":"2016-05-06T08:57:42","guid":{"rendered":"http:\/\/symbioticindia.in\/docu\/?p=46"},"modified":"2016-05-06T08:57:42","modified_gmt":"2016-05-06T08:57:42","slug":"sugar-crm-integration-with-custom-php-applications-ii","status":"publish","type":"post","link":"http:\/\/symbioticindia.in\/docu\/2016\/05\/06\/sugar-crm-integration-with-custom-php-applications-ii\/","title":{"rendered":"Sugar CRM integration with custom PHP applications (II)"},"content":{"rendered":"

Using SugarCRM as an authentication system<\/strong><\/h4>\n

Demo available : <\/strong>you can now directly test what’s explained in this article. A demo is available here<\/a>.<\/p>\n\n\n\n
<\/object><\/td>\nIntroduction<\/strong>
\nHere we are again with this series of articles about SugarCRM integration. This time we’ll explore the use of sugar as authentication system and user manager for custom PHP applications. Starting from the php class we wrote in the first article<\/a>, we’ll expand it with some more functionalities; then we’ll write the basic code to be used in our applications to communicate with sugar.<\/p>\n

Basically, we’ll have a registration form on our application, filling it a record will be created on sugar “Contacts”, together with a given password. To effectively activate the new user, a sugar user will have to log in into the crm and check the access enabling checkbox. This is really the essential, a lot of other features can be added like notification emails, user groups, more articulated user status(not just enabled\/disabled) and so on, but this is up to the php application developer. Once again sugar SOAP interface will be our swiss knife.<\/span><\/p>\n

\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

SugarCRM configuration<\/strong><\/h4>\n

We’ll use sugarcrm Contacts module as our application users repository. What we need on sugar side are just a couple of new custom fields: a password text field and a checkbox to enable\/disable the user login on our system. Please note that saying “users” I refer to our custom application users, not sugar users. To be clearer, sugar users are those that can login into sugarcrm interface. Our users are what on sugarcrm are “contacts”.
\nAfter creating the new custom fields we need to add the checkbox in sugar Contacts EditView panel, to be able to effectively use it.
\nObscure? Don’t worry, I’ve done a simple animation with wink, detailing all the process.You can watch it here<\/a>
\nWe are now ready on the sugar side. What SOAP are we going to use this time?
\nWe’ve already seen (see previous article<\/a>) how to query sugarcrm via SOAP, so we are already able to check if a user exists and is enabled, now we need to write to sugar(when a new user gets created). Our SOAP method is set_entry<\/em>. Let’s see the new code to add to our SugarSoap class….<\/p>\n

New methods in SugarSoap class<\/strong>
\nFirst we add a generic setEntry function that will be used for writing on various sugarcrm modules:<\/p>\n

<\/span><\/p>\n

\/**<\/span>\r\n*<\/span>       Modify<\/span> sugar<\/span> entry<\/span> with<\/span> given<\/span> data<\/span>(<\/span>used<\/span> by<\/span> other<\/span> set<\/span>#<\/span>#<\/span>#<\/span> functions<\/span>)<\/span> \r\n*<\/span>\r\n*<\/span>*\/<\/span>             \r\nfunction<\/span> setEntry<\/span>($<\/span>module<\/span>,<\/span>$<\/span>array<\/span>){<\/span>\r\n        $<\/span>data_array<\/span>=<\/span>array<\/span>();<\/span>\r\n        while<\/span>(list<\/span>($<\/span>name<\/span>,<\/span>$<\/span>value<\/span>)=<\/span>each<\/span>($<\/span>array<\/span>)){<\/span>\r\n                $<\/span>data_array<\/span>[<\/span>]<\/span>=<\/span> array<\/span>(\r\n                        '<\/span>name<\/span>'<\/span>  =<\/span>><\/span>      $<\/span>name<\/span>,<\/span>\r\n                        '<\/span>value<\/span>'<\/span> =<\/span>><\/span>      $<\/span>value<\/span>  \r\n                );<\/span>\r\n        }<\/span>\r\n        $<\/span>result<\/span> =<\/span> $this<\/strong><\/span>->proxy<\/strong><\/span>->set_entry<\/span>(\r\n                $this<\/strong><\/span>->sess<\/span>,<\/span>\r\n                $<\/span>module<\/span>,<\/span>\r\n                $<\/span>data_array<\/span>\r\n        );<\/span>\r\n        return<\/span> $<\/span>result<\/span>;<\/span>\r\n}<\/span><\/pre>\n
<\/p>\n
The set_entry<\/em> method of sugar soap interface requires 3 parameters:
\n<\/span><\/p>\n
    \n
  1. A valid sugar session id<\/li>\n
  2. The module name (i.e. Contacts)<\/li>\n
  3. The data array in sugar format(a name\/value couple for each field)<\/li>\n<\/ol>\n
    In our setEntry method, we’re passing an associative array, so with the “while” loop we turn it into a sugarcrm accepted array. A note about set_entry<\/em> : if an “id” field is passed within the data_array parameter, sugarcrm will do an update of the record with the given id, othewise it will be intended as an “insert”, and a new record will be created.
    \nNow we can add “setXXX” methods very easily for the modules we’re interested in. In this case:<\/p>\n
    <\/span><\/p>\n
    function<\/span> setContact<\/span>($<\/span>array<\/span>){<\/span>\r\n        return<\/span> $this<\/strong><\/span>->setEntry<\/span>(\"<\/span>Contacts<\/span>\"<\/span>,<\/span>$<\/span>array<\/span>);<\/span>\r\n}<\/span><\/pre>\n
    <\/p>\n
    The authentication class<\/strong>
    \nWhat we need is a simple class to manage new user creation and authentication of existing users.
    \nHere is a draft:<\/p>\n
    <\/span><\/p>\n
    <?php<\/span>\r\ninclude_once<\/span> \"<\/span>SugarSoap<\/span>.<\/span>php<\/span>\"<\/span>;<\/span>\r\nclass<\/span> UserManagement<\/strong><\/span>{<\/span>\r\n        var<\/span> $<\/span>soap<\/span>;<\/span>\r\n        function<\/span> UserManagement<\/span>(){<\/span>\r\n                \/\/<\/span> here<\/span> goes<\/span> your<\/span> sugar<\/span> installation<\/span> address<\/span>\r\n                $this<\/strong><\/span>->soap<\/span>=<\/span>new<\/span> SugarSoap<\/span>('<\/span>http:\/\/mysugar\/soap.php?wsdl<\/span>'<\/span>);<\/span>\r\n        }<\/span>               \r\n        function<\/span> authenticate<\/span>($<\/span>email<\/span>,<\/span>$<\/span>password<\/span>){<\/span>\r\n                $<\/span>result<\/span>=<\/span>$this<\/strong><\/span>->soap<\/strong><\/span>->getContacts<\/span>(\"<\/span> contacts_cstm<\/span>.<\/span>can_login_c<\/span>=<\/span>'<\/span>1<\/span>'<\/span> \r\n                                                and<\/span> contacts<\/span>.<\/span>email1<\/span>=<\/span>'<\/span>\"<\/span>.<\/span>$<\/span>email<\/span>.<\/span>\"<\/span>'<\/span> \r\n                                                and<\/span> contacts_cstm<\/span>.<\/span>password_c<\/span>=<\/span>'<\/span>\"<\/span>.<\/span>$<\/span>password<\/span>.<\/span>\"<\/span>'<\/span>\"<\/span>,<\/span>\r\n                                                1<\/span>,<\/span>\"<\/span>\"<\/span>);<\/span>\r\n                if<\/span>($<\/span>result<\/span>[<\/span>'<\/span>result_count<\/span>'<\/span>]<\/span>><\/span>0<\/span>){<\/span>\r\n                        \/\/<\/span> Authenticated<\/span>\r\n                        \/\/<\/span> transform<\/span> return<\/span> values<\/span> into<\/span> an<\/span> associative<\/span> array<\/span>\r\n                        $<\/span>result<\/span>=<\/span>$this<\/strong><\/span>->soap<\/strong><\/span>->nameValuePairToSimpleArray<\/span>(\r\n                                        $<\/span>result<\/span>[<\/span>'<\/span>entry_list<\/span>'<\/span>]<\/span>[<\/span>0<\/span>]<\/span>[<\/span>'<\/span>name_value_list<\/span>'<\/span>]<\/span>);<\/span>\r\n                        \/**<\/span>\r\n                        *<\/span>       Here<\/span> we<\/span> can<\/span> add<\/span> code<\/span> for<\/span> managing<\/span> the<\/span> authenticated<\/span> user<\/span>,<\/span> \r\n                        *<\/span>       for<\/span> example<\/span> put<\/span> some<\/span> user<\/span> data<\/span> in<\/span> a<\/span> session<\/span> variable<\/span>\r\n                        *<\/span>       (<\/span>id<\/span>,<\/span> first<\/span> and<\/span> last<\/span> name<\/span>,<\/span> email<\/span> etc<\/span>.<\/span>)<\/span>\r\n                        *<\/span>       Something<\/span> like<\/span> this<\/span>:<\/span>\r\n                        *<\/span>*\/<\/span>\r\n                        $<\/span>_SESSION<\/span>[<\/span>'<\/span>user_data<\/span>'<\/span>]<\/span>=<\/span>$<\/span>result<\/span>;<\/span>\r\n                        return<\/span> true<\/span>;<\/span>\r\n                }<\/span> else<\/span>{<\/span> \r\n                        \/\/<\/span> Not<\/span> authenticated<\/span>\r\n                        \/**<\/span>\r\n                        *<\/span>       and<\/span> here<\/span> we<\/span> can<\/span> add<\/span> code<\/span> for<\/span> managing<\/span> the<\/span> authentication<\/span> error<\/span>,<\/span> \r\n                        *<\/span>       for<\/span> example<\/span> a<\/span> notification<\/span> email<\/span> to<\/span> someone<\/span>     \r\n                        *<\/span>*\/<\/span>\r\n                        return<\/span> false<\/span>;<\/span>\r\n                }<\/span>\r\n        }<\/span>\r\n        \r\n}<\/span>\r\n?><\/span><\/pre>\n
    <\/p>\n
    Let’s focus on the method “authenticate”. This is obviously used to check the credentials for a user who’s trying to log in into our application. When calling the “getContacts” method, we check that the user is authorized(can_login=1), and that her\/his email\/password pair is correct. If someone matches, the result_count field will be greater than zero.<\/span><\/p>\n
    In an hypothetic user registration process we also need a “createUser” method” expecting at least an email and a password. Here it is :<\/p>\n
    function<\/span> createUser<\/span>($<\/span>email<\/span>,<\/span>$<\/span>password<\/span>){<\/span>\r\n        return<\/span> $this<\/strong><\/span>->soap<\/strong><\/span>->setContact<\/span>(array<\/span>(\r\n                        \"<\/span>email1<\/span>\"<\/span>        =<\/span>><\/span> $<\/span>email<\/span>,<\/span>\r\n                        \"<\/span>password_c<\/span>\"<\/span>    =<\/span>><\/span> $<\/span>password<\/span>\r\n        ));<\/span>\r\n}<\/span><\/pre>\n

    \nRemember that the email field name in sugar “Contacts” module is “email1” and that password is the custom field “password_c” field we created.<\/p>\n
    A basic user registration page<\/strong>
    \nAt this point we have all the basics to manage a simple authentication process. A simple “register.php” page could be something like this:
    \n<\/span><\/p>\n
    <?php<\/span>\r\n\/**<\/span>\r\n*<\/span>       Trivial<\/span> and<\/span> incomplete<\/span> example<\/span> of<\/span>\r\n*<\/span>       user<\/span> registration<\/span>.<\/span> Missing<\/span> are<\/span> lots<\/span> of<\/span>\r\n*<\/span>       things<\/span>,<\/span> like<\/span> password<\/span> confirmation<\/span> or<\/span> \r\n*<\/span>       checking<\/span> that<\/span> a<\/span> user<\/span> with<\/span> the<\/span> same<\/span> email<\/span>\r\n*<\/span>       is<\/span> already<\/span> registered<\/span> on<\/span> the<\/span> system<\/span>\r\n*<\/span>\r\n*<\/span>*\/<\/span>\r\nif<\/span>(isset<\/span>($<\/span>_POST<\/span>[<\/span>'<\/span>submit<\/span>'<\/span>]<\/span>)){<\/span>\r\n        require_once<\/span> \"<\/span>UserManagement<\/span>.<\/span>php<\/span>\"<\/span>;<\/span>\r\n        $usman<\/strong><\/span>=<\/span>new<\/span> UserManagement<\/span>();<\/span>\r\n        $usman<\/strong><\/span>->createUser<\/span>($<\/span>_POST<\/span>[<\/span>'<\/span>email<\/span>'<\/span>]<\/span>,<\/span>$<\/span>_POST<\/span>[<\/span>'<\/span>password<\/span>'<\/span>]<\/span>);<\/span>\r\n        echo<\/span> \"<\/span>User<\/span> created<\/span>\"<\/span>;<\/span>\r\n        die<\/span>();<\/span>\r\n}<\/span>\r\n\r\n?><\/span>\r\n<<\/span>html<\/span>><\/span>\r\n<<\/span>body<\/span>><\/span>\r\n<<\/span>form<\/span> method<\/span>=<\/span>POST<\/span>><\/span>\r\n<<\/span>table<\/span>><\/span>\r\n        <<\/span>tr<\/span>><\/span>\r\n                <<\/span>td<\/span>><\/span>Email<<\/span>\/<\/span>td<\/span>><\/span>\r\n                <<\/span>td<\/span>><\/span><<\/span>input<\/span> type<\/span>=<\/span>text<\/span> name<\/span>=<\/span>email<\/span>><\/span><<\/span>\/<\/span>td<\/span>><\/span>\r\n        <<\/span>\/<\/span>tr<\/span>><\/span>\r\n        <<\/span>tr<\/span>><\/span>\r\n                <<\/span>td<\/span>><\/span>Password<<\/span>\/<\/span>td<\/span>><\/span>\r\n                <<\/span>td<\/span>><\/span><<\/span>input<\/span> type<\/span>=<\/span>password<\/span> name<\/span>=<\/span>password<\/span>><\/span><<\/span>\/<\/span>td<\/span>><\/span>\r\n        <<\/span>\/<\/span>tr<\/span>><\/span>\r\n        <<\/span>tr<\/span>><\/span>\r\n                <<\/span>td<\/span> colspan<\/span>=<\/span>2<\/span> align<\/span>=<\/span>center<\/span>><\/span>\r\n                        <<\/span>input<\/span> type<\/span>=<\/span>submit<\/span> name<\/span>=<\/span>submit<\/span> value<\/span>=<\/span>\"<\/span>Register<\/span>\"<\/span>><\/span>\r\n                <<\/span>\/<\/span>td<\/span>><\/span>\r\n        <<\/span>\/<\/span>tr<\/span>><\/span>\r\n<<\/span>\/<\/span>table<\/span>><\/span>        \r\n<<\/span>\/<\/span>form<\/span>><\/span>\r\n<<\/span>\/<\/span>body<\/span>><\/span>\r\n<<\/span>\/<\/span>html<\/span>><\/span> <\/span><\/pre>\n
    <\/p>\n
    The newly created user won’t be able to log in into the system because the custom field “can_login_c” defaults to 0. A sugar user has to check that field to enable user access to the application. In a complete process there will be notification emails, fields controls and other security related stuff.<\/p>\n
    A sample login page will be something like this:
    \n<\/span><\/p>\n
    <?php<\/span>\r\n\/**<\/span>\r\n*<\/span>       Similar<\/span> notes<\/span> as<\/span> for<\/span> the<\/span> registration<\/span>\r\n*<\/span>       page<\/span>.<\/span>\r\n*<\/span>*\/<\/span>\r\nif<\/span>(isset<\/span>($<\/span>_POST<\/span>[<\/span>'<\/span>submit<\/span>'<\/span>]<\/span>)){<\/span>\r\n        require_once<\/span> \"<\/span>UserManagement<\/span>.<\/span>php<\/span>\"<\/span>;<\/span>\r\n        $usman<\/strong><\/span>=<\/span>new<\/span> UserManagement<\/span>();<\/span>\r\n        if<\/span>($usman<\/strong><\/span>->authenticate<\/span>($<\/span>_POST<\/span>[<\/span>'<\/span>email<\/span>'<\/span>]<\/span>,<\/span>$<\/span>_POST<\/span>[<\/span>'<\/span>password<\/span>'<\/span>]<\/span>)){<\/span>\r\n                echo<\/span> \"<\/span>User<\/span> authenticated<\/span>\"<\/span>;<\/span>\r\n        }<\/span>else<\/span> {<\/span>\r\n                echo<\/span> \"<\/span>Authentication<\/span> error<\/span>\"<\/span>;<\/span>            \r\n        }<\/span>\r\n        die<\/span>();<\/span>\r\n}<\/span>\r\n\r\n?><\/span>\r\n<<\/span>html<\/span>><\/span>\r\n<<\/span>body<\/span>><\/span>\r\n<<\/span>form<\/span> method<\/span>=<\/span>POST<\/span>><\/span>\r\n<<\/span>table<\/span>><\/span>\r\n        <<\/span>tr<\/span>><\/span>\r\n                <<\/span>td<\/span>><\/span>Email<<\/span>\/<\/span>td<\/span>><\/span>\r\n                <<\/span>td<\/span>><\/span><<\/span>input<\/span> type<\/span>=<\/span>text<\/span> name<\/span>=<\/span>email<\/span>><\/span><<\/span>\/<\/span>td<\/span>><\/span>\r\n        <<\/span>\/<\/span>tr<\/span>><\/span>\r\n        <<\/span>tr<\/span>><\/span>\r\n                <<\/span>td<\/span>><\/span>Password<<\/span>\/<\/span>td<\/span>><\/span>\r\n                <<\/span>td<\/span>><\/span><<\/span>input<\/span> type<\/span>=<\/span>password<\/span> name<\/span>=<\/span>password<\/span>><\/span><<\/span>\/<\/span>td<\/span>><\/span>\r\n        <<\/span>\/<\/span>tr<\/span>><\/span>\r\n        <<\/span>tr<\/span>><\/span>\r\n                <<\/span>td<\/span> colspan<\/span>=<\/span>2<\/span> align<\/span>=<\/span>center<\/span>><\/span>\r\n                        <<\/span>input<\/span> type<\/span>=<\/span>submit<\/span> name<\/span>=<\/span>submit<\/span> value<\/span>=<\/span>\"<\/span>Login<\/span>\"<\/span>><\/span>\r\n                <<\/span>\/<\/span>td<\/span>><\/span>\r\n        <<\/span>\/<\/span>tr<\/span>><\/span>\r\n<<\/span>\/<\/span>table<\/span>><\/span>        \r\n<<\/span>\/<\/span>form<\/span>><\/span>\r\n<<\/span>\/<\/span>body<\/span>><\/span>\r\n<<\/span>\/<\/span>html<\/span>><\/span> <\/span><\/pre>\n
    Should be quite self-explanatory.<\/p>\n
    From here it should be easy to build a robust, comfortable and easy to manage authentication system. As you’ve seen, the amount of code to be written is fairly low, as most of the job is demanded to sugar. There are a number of features we can add to make a more powerful system. Here are a few:<\/p>\n
      \n
    1. Encoded passwords(md5 or sha). This would ensure a higher level of security in case of db tampering, but will make password recovery impossible.
      \nYou could prefer one method or the other depending on numerous factors.<\/li>\n
    2. A status field instead of a simple “can_login” checkbox, for example to have waiting for approval,enabled,blocked,revoked users.
      \nIn this case you’d need to create a dropdown field in sugar.<\/li>\n
    3. A “group” field, to implement different privileges for different users<\/li>\n<\/ol>\n
      and so on. I hope that this overview is clear enough to allow anyone to tailor her\/his own system easily.<\/p>\n
      Before closing the article<\/strong>
      \nJust wanted to name another useful method of sugar soap interface. I’m talking about “get_module_fields”.
      \nThis is a simple method that accepts as parameters a session id and the module name and gives back a list of available fields for the given modules. This is quite useful while developing on sugar\/soap. I’m not going to write here the code to use it because you already know how to do…..<\/span><\/p>\n
      Resources<\/strong>
      \nSugar CRM integration with custom PHP applications (I) <\/a>
      \nThe first article of this series. There you will find the basis of what exposed in the current article.<\/p>\n
      Sugar CRM integration – website session and SOAP session<\/a>
      \nThe third article of this series. It’s about how to use web\/soap session ids\u00a0 in SugarCRM.<\/p>\n
       <\/p>\n","protected":false},"excerpt":{"rendered":"
      Using SugarCRM as an authentication system Demo available : you can now directly test what’s explained in this article. A demo is available here. Introduction Here we are again with this series of articles about SugarCRM integration. This time we’ll explore the use of sugar as authentication system and user manager for custom PHP applications. ..<\/p>\n
      <\/div>\n
      Read more<\/a><\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[6,2],"tags":[],"class_list":["post-46","post","type-post","status-publish","format-standard","hentry","category-php","category-sugarcrm"],"_links":{"self":[{"href":"http:\/\/symbioticindia.in\/docu\/wp-json\/wp\/v2\/posts\/46","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/symbioticindia.in\/docu\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/symbioticindia.in\/docu\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/symbioticindia.in\/docu\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"http:\/\/symbioticindia.in\/docu\/wp-json\/wp\/v2\/comments?post=46"}],"version-history":[{"count":1,"href":"http:\/\/symbioticindia.in\/docu\/wp-json\/wp\/v2\/posts\/46\/revisions"}],"predecessor-version":[{"id":47,"href":"http:\/\/symbioticindia.in\/docu\/wp-json\/wp\/v2\/posts\/46\/revisions\/47"}],"wp:attachment":[{"href":"http:\/\/symbioticindia.in\/docu\/wp-json\/wp\/v2\/media?parent=46"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/symbioticindia.in\/docu\/wp-json\/wp\/v2\/categories?post=46"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/symbioticindia.in\/docu\/wp-json\/wp\/v2\/tags?post=46"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}