psy

DropboxAPI

Recommended Posts

ProcessWire DropboxAPI on GitHub: https://github.com/clipmagic/DropboxAPI

 

This module is a wrapper for Kunal Varma's Dropbox PHP SDK https://github.com/kunalvarma05/dropbox-php-sdk

It was created to perform a specific function for a client, ie upload PDF files on a PW website to a specific Dropbox account folder.

The PDF files, created using @Wanze's excellent PagesToPdf module using the WirePDF functions, are generated from Formbuilder forms completed by front-end site visitors.  Works a treat!

There's more that could be done to allow ProcessWire to take advantage of all the features of the SDK, eg downloads, multiple Dropbox accounts, etc. You are welcome to request changes and/or fork the GitHub project to extend the feature set.

Enjoy!

System requirements

  • PHP 5.6.4 or greater
  • Composer
  • The PHP mbstring extension

General information

This module enables you to access a single Dropbox (www.dropbox.com) account to upload files from a ProcessWire website.

All kudos to (https://github.com/kunalvarma05/dropbox-php-sdk) for the PHP API.

First steps

  • Visit (https://www.dropbox.com/developers) and read the documentation.
  • Log into Dropbox and create a new application. It's recommended to limit ProcessWire App access to a specified folder
  • Make a note of the App key, the App secret and the name of the Dropbox folder

Installation

  • Download the zip file into your site/modules folder then expand the zip file.
  • Next, login to ProcessWire > go to Modules > click "Refresh". You should see a note that a new module was found. Install the DropboxAPI module.
  • Configure the module with your App key, App secret and your Call Back URL

You need to generate a Dropbox access token to enable your site to communicate with the nominated Dropbox account. Dropbox will generate a token for you or you can create a page for the front end of your ProcessWire site with a template to submit the token request to Dropbox, eg:

    <?php namespace ProcessWire;
    
    $drop = $modules->get('DropboxAPI');
    
    if ($input->get->code && $input->get->state) {
        $code = $sanitizer->text($input->get->code);
        $state = $sanitizer->text($input->get->state);
    
        //Fetch the AccessToken
        $accessToken = $drop->getAccessToken($code, $state);
    
        echo "Copy/paste this code into the module configuration: " .  $accessToken;
    
    } else {
        echo  "<p><a href='" . $drop->getAuthURL() . "'>Log in with Dropbox</a></p>";
    }
    ?>

Once you have entered the token in the module configuration, you can unpublish this page.

Usage

Read the dropbox-php-sdk documentation!

An example template for sending a file to a Dropbox App folder from ProcessWire:

    <?php namespace ProcessWire;
    use Kunnu\Dropbox\Dropbox;
    use Kunnu\Dropbox\DropboxApp;
    use Kunnu\Dropbox\DropboxFile;
    
    // send pdf to Dropbox
    $drop = $modules->get('DropboxAPI');
    $app = new DropboxApp($drop->app_key, $drop->app_secret, $drop->authorization_code);
    if ($app) {
        //Configure Dropbox service
        $dropbox = new Dropbox($app);
        $dropboxFile = new DropboxFile('/path/to/myfilename.pdf');
        $file = $dropbox->upload($dropboxFile, "/myfilename.pdf", ['autorename' => true]);
        //Uploaded File meta data
        if ($file) {
            $success = $file->getName() . " uploaded to Dropbox";
            $drop->log($success);
        }
    }

 

 

  • Like 13

Share this post


Link to post
Share on other sites

Thanks for sharing this module, @psy! Will definitely give this a try soon.

Just one observation at this point: only Process modules should have the Process prefix in their name, and since this isn't a Process module (i.e. it doesn't extend Process), I'd suggest considering another name for clarity. Perhaps just dropping the Process prefix? :)

  • Like 3

Share this post


Link to post
Share on other sites

@teppo

Thanks for the tip. Was a bit confused about naming conventions. The module doesn't render anything so not Markup, and to me, it was a 'process', although granted, not a PW process. 

Done. Let me know if there are any problems relating to the name change.

  • Like 3

Share this post


Link to post
Share on other sites

At this point my best suggestions would be DropboxAPI, just plain Dropbox, or perhaps DropboxUpload... though that last one only if you are sure that you'll never add anything other than upload support for it :)

Share this post


Link to post
Share on other sites
Quote
3 minutes ago, teppo said:

At this point my best suggestions would be DropboxAPI, just plain Dropbox, or perhaps DropboxUpload... though that last one only if you are sure that you'll never add anything other than upload support for it :)

Changed it to DropboxAPI :)

 

 

  • Like 2

Share this post


Link to post
Share on other sites

Tip:

By default the Dropbox App is in Development mode and allows only one user - you. When you apply for a token you may get a Dropbox notification saying you need more users. Simply go back into your Dropbox App configuration and click on the button to the right of this setting. You'll automatically be granted 500 development users.

Should you need more than 500 users, you'll need to apply to Dropbox for Production status for your App and totally outside the scope of this ProcessWire Dropbox API module.

  • Like 3

Share this post


Link to post
Share on other sites

Hi!

Great module. Two requests:

  • Could the token step be incorperated into the admin settings or a required Process module?
  • I've been thinking for ages to whether it was possible to view the contents of a folder from dropbox on your site and create public links to files - use case: upload your resources to this folder in dropbox and they'll automatically appear on the site?

Thanks!

  • Like 1

Share this post


Link to post
Share on other sites

@benbyf

Thanks Ben

  • The token request could be on the admin side BUT the Dropbox call back URL must be a publicly viewable page to receive the token. I chose to put both the request and response on the same page and then unpublish the page once I'd received the token.
  • According to the documentation, https://github.com/kunalvarma05/dropbox-php-sdk/wiki/Working-with-files the answer is yes. The PW module really does little more than authenticate the user and allow you to create the $dropbox object (as in example above for sending a file). Add all the appropriate "use" namespace statements in your template and you'll have full access to the API, including the ability to List Folder Contents
  • Like 3

Share this post


Link to post
Share on other sites

great, will be sending you some Pull Requests in the near future :)

  • Like 1

Share this post


Link to post
Share on other sites

@benbyf 

On 14/08/2017 at 0:43 AM, benbyf said:

I've been thinking for ages to whether it was possible to view the contents of a folder from dropbox on your site and create public links to files - use case: upload your resources to this folder in dropbox and they'll automatically appear on the site?

Tested and confirmed you can do this. Simple example (no paging although that's possible too):

<?php namespace ProcessWire;

use Kunnu\Dropbox\Dropbox;
use Kunnu\Dropbox\DropboxApp;
use Kunnu\Dropbox\DropboxFile;

$drop = $modules->get('DropboxAPI');
//Configure Dropbox Application
$app = new DropboxApp($drop->app_key, $drop->app_secret, $drop->authorization_code);
//Configure Dropbox service
$dropbox = new Dropbox($app);
$listFolderContents = $dropbox->listFolder(""); //root folder is the folder you nominated in the Dropbox App config. Refer doco
$items = $listFolderContents->getItems();
?>
<ul>
    <?php foreach ($items as $item) : ?>
       <li><?=$item->getName()?></li>
    <?php endforeach; ?>
</ul>

As for download links, you could use the Dropbox Chooser https://www.dropbox.com/developers/chooser#javascript or create your own with javascript.

 

  • Like 2

Share this post


Link to post
Share on other sites

Hi sorry not big PHP dev (mainly front end) and none of the module makes sense to me (lots of namespaces). getting errors like this: Class 'Kunnu\Dropbox\DropboxApp' not found in /srv/users/serverpilot/apps/fabricacapital/public/site/templates/dropbox.php:8 on the public pages implementing either of teh code demos above. Any help would be ace!

Also I mamanged to get a app code directly in the dropbox developer portal, so no need for the token generating step above.

Share this post


Link to post
Share on other sites

Hi @benbyf

Yeah, the namespace stuff did my head in too! Adding them at the top of the page template under <?php namespace ProcessWire; was the only way I could get it to work. Once they're there, and the PW module is loaded, it's a matter of following the dropbox-api-sdk documentation to the letter.

Ooops! Just realised the GitHub version of the module has an error. Will upload fix.

Share this post


Link to post
Share on other sites

@benbyf DropboxAPI.module file fixed and uploaded to GitHub. Please update your version and let me know how you get on.

  • Like 1

Share this post


Link to post
Share on other sites

soooo confused about this module, how did you get it to work?!

e.g. /vendor/ and autoload.php folder/files don't exist in the repo.

Share this post


Link to post
Share on other sites

Did you do the upgrade to DropboxAPI.module ? The original version in GitHub looked for the wrong path to the autoload.php of the SDK files. This is what it should be:

require_once dirname(__FILE__) . '/dropbox-php-sdk/vendor/autoload.php';

From what I can gather from the error you mentioned, the SDK files aren't being loaded. The updated code should fix that.

Share this post


Link to post
Share on other sites

yep, updated. But like i mentioned there is simply no file called autoload in the repo... let allow a folder called vendor

Share this post


Link to post
Share on other sites

@benbyf are you using composer? Or manually downloading the packages?

vendor directory and autoload.php is created when you require a package with composer. 

  • Like 1

Share this post


Link to post
Share on other sites

Think I know what's going on, starting with my limited knowledge of github. Trying to work it out...

Share this post


Link to post
Share on other sites
10 minutes ago, abdus said:

@benbyf are you using composer? Or manually downloading the packages?

vendor directory and autoload.php is created when you require a package with composer. 

Good point, not needed to use composer with Processwire yet, so didnt reach for it this time. I'm guess thats the problem then? Also no mention in teh installation notes either but might because i dont know what to look for maybe?

Am i right in saying using composer also makes a module incompatible with the PW admin module installer?

Share this post


Link to post
Share on other sites

WORKED!!!!! WHHHHOOOOPPPP. Thank you! Obvioulsy a bit of a n00b still for "proper" dev stuff. any good articles about composer best practises?

Thanks

  • Like 1

Share this post


Link to post
Share on other sites

Think I've sorted GitHub. Let me know if anyone has probs getting the module from there.

  • Like 1

Share this post


Link to post
Share on other sites

Just in case its useful for anyone, this is my function for creating a folder list with public links to files:

<?php namespace ProcessWire;
use Kunnu\Dropbox\Dropbox;
use Kunnu\Dropbox\DropboxApp;
use Kunnu\Dropbox\DropboxFile;

$drop = $modules->get('DropboxAPI');
//Configure Dropbox Application
$app = new DropboxApp($drop->app_key, $drop->app_secret, $drop->authorization_code);
//Configure Dropbox service
$dropbox = new Dropbox($app);

// get folder from user
$folder_path = "";
$folder_path = $user->folder;

// get items from dropbox folder
$listFolderContents = $dropbox->listFolder($folder_path); //root folder is the folder you nominated in the Dropbox App config. Refer doco
$items = $listFolderContents->getItems();

function listItems($items, $dropbox, $depth = 0){

    $out = "<ul class='depth-{$depth}'>";

    foreach ($items as $item){

        // get file name
        $name = $item->getName();

        // getPathLower
        $path = $item->getpathLower();
        $thumbPath = "no thumb";
        $thumbHasExt = strpos($path, '.');

        // file
        if($thumbHasExt && $path){

            $file = $dropbox->getTemporaryLink($path);
            $link = $file->getLink();
            $ext = substr($path, $thumbHasExt+1);
			// fontawesome file name icons
            $icon = "fa-file-o";
            switch ($ext) {
                case 'png':
                case 'jpg':
                case 'gif':
                case 'psd':
                case 'tiff':
                    $icon = 'fa-file-image-o';
                    break;
                case 'pdf':
                    $icon = 'fa-file-pdf-o';
                    break;
                case 'mp3':
                case 'wav':
                    $icon = 'fa-file-audio-o';
                    break;
                case 'mov':
                case 'mp4':
                case 'm4a':
                    $icon = 'fa-file-video-o';
                    break;
                case 'doc':
                case 'docx':
                    $icon = 'fa-file-word-o';
                    break;
                case 'xls':
                case 'xlsx':
                    $icon = 'fa-file-excel-o';
                    break;
                case 'ppt':
                case 'pptx':
                    $icon = 'fa-file-powerpoint-o';
                    break;
                case 'zip':
                case 'rar':
                    $icon = 'fa-file-archive-o';
                    break;
            }

            $out .= "<li><span class='{$icon} fa'></span><a title='click to download' href='{$link}'>{$name} {$ext}</a></li>";

        // folder
        }else{
            ++$depth;

            $out .= "<li><span class='fa-folder-open-o fa'></span>{$name}";

            $listSubFolderContents = $dropbox->listFolder($path);
            $items = $listSubFolderContents->getItems();

            // get list of files in subfolder
            $out .= listItems($items, $dropbox, $depth);

            $out .= "</li>";
        }
    }
    $out .= "</ul>";

    return $out;
}
// get depth 0 folder items
$out = listItems($items, $dropbox, $depth);

 

  • Like 3

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By BitPoet
      I'm really in love with FormBuilder, but the one thing missing to match all my end users' expectations were repeatable field groups. Think repeaters, in ProcessWire terms. Our primary application of PW is our corporate intranet, so "lines" of fields are quite common in the forms I build. We have all kinds of request forms where the information for a varying number of colleagues needs to be entered (from meal order to flight booking request) and where it is simply impractical to send a form for each, and I don't want to clutter my forms with multiple instances of fields that may only get used ten percent of the time.
      That's why I started to build FormBuilderMultiplier (link to GitHub).
      What it does:
      Adds an option to make a regular Fieldgroup repeatable Lets you limit the number of instances of a Fieldgroup on the form Adds an "Add row" button the form that adds another instance of the Fieldgroup's fields Adds a counter suffix at the end of every affected field's label Stores the entered values just like regular fields Makes the entered values available in preview and email notifications Supports most text based fields, textareas and selects (really, I haven't had enough time to test all the available choices yet) What it doesn't do (yet):
      Support saving to ProcessWire pages (i.e. real Repeaters) I haven't tested all the validation stuff, Date/Time inputs etc. yet, but since I'm utterly swamped with other stuff at work, I didn't want to wait until I have it polished. Any feedback is welcome. There might also be some issues with different output frameworks that I haven't encountered yet. The forms I work with mostly use UIKit.
      Status:
      Still alpha, so test well before using it in the field.
      Known issues:
      When rows are added, the form's iframe needs to be resized, which isn't completely clean yet.
      How it works:
      The Fieldgroup settings are added through regular hooks, as is the logic that adds the necessary field copies for processing the form and displaying previews.
      "Multiplied" field instances are suffixed with _NUM, where NUM is an incremental integer starting from 1. So if you have add two fields named "surname" and "givenname" to a fieldgroup and check the "multiply" checkbox, the form will initially have "surname_1" and "givenname_1" field (I'm still considering changing that to make the risk to shoot oneself into the foot by having a regular "surname_1" field somewhere else in the form less likely).
      When a "row" is added, the first row is cloned through JS and the counter in the fields' IDs, names and "for" attributes as well as the counter in the label are incremented before appending the copies to the Fieldset container in the form.
      To keep backend and frontend in sync, a hidden field named [name of the fieldset]__multiplier_rows is added to the form. Both the backend and the frontend script use this to store and retrieve the number of "rows".
      ToDo:
      Naturally, add the option to store the data in real repeaters when saving to pages. Do a lot of testing (and likely fixing). Make a few things (like the "Add row" button label etc.) configurable in field(set) context. Add a smooth API to retrieve the multiplied values as WireArrays. The mandatory moving screenshot:

    • By MoritzLost
      Hello there,
      I'm working on a tiny textformatter module that searches the text for titles of other pages on your site and creates hyperlinks to them. I'm not sure if something like this exists already, but I haven't found anything in the module directory, so I wrote my own solution 🙂
      It's not properly tested yet and is still missing some functionality I would like to implement, so at the moment it should be considered in BETA. Features include limiting the pages that will get searched by template, and adding a custom CSS class to the generated hyperlinks. As I'm writing this I noticed that it will probably include unpublished and hidden pages at the moment, so yeah ... it's still in development alright 😅
      You can download the module from Github:
      https://github.com/MoritzLost/TextformatterPageTitleLinks
      There's some more information in the readme as well.
      Anyway, let me know what you think! I'm happy about any feedback, possible improvements or ideas on how to improve the module. Cheers.
    • By adrian
      This module provides a way to rapidly generate Page fields and the required templates and pages for use as a drop down select (or any other Page field type).
      This module will let you create a full page field setup in literally a few seconds 
      To use, run Page Field Select Creator from the Setup Menu
      Enter a Field Title, eg: Room Types Select Options - These will become the child pages that will populate the page field select options. There are two different options.
       
      Option 1. TITLE FIELD ONLY - enter one option per line, eg:
       
      Single
      Double
      Suite
       
       
      Option 2. MULTIPLE FIELDS - the first line is used for the field names and the first field must be 'Title'. Subsequent lines are the values for the fields, eg:
       
      Title, Number of Beds, Number of People, Kitchen Facilities
      Single, 1, 1, Fridge Only
      Double, 2, 2, Fridge Only
      Suite, 3, 6, Full Kitchen
        Choose the parent where the page tree of options will be created, eg a hidden "Options" parent page Select a "Deference in API as" option depending on your needs Choose the input field type Check whether "Allow new pages to be created from field?" should be enabled. As an example, if you entered "Room Types" as the field title, you would end up with all of the following automatically created:
      a fully configured page field called: room_types MULTIPLE FIELDS OPTION - 3 additional fields - number_of_beds, number_of_people, kitchen a parent template called: room_types a child template called: room_types_items (with either just a title field, or with the 3 additional fields as well) a parent page called: Room Types a series of child pages named and titled based on the per line entries in the Select Options textarea The templates are configured such that the "room_types_items" child template can only have the main "room_types" template as a parent, and vice versa.

      Then all you have to do is add the newly created page field to any template you want and you're ready to go!
       
      You can grab it from:
       
      Modules directory: http://modules.processwire.com/modules/process-page-field-select-creator/
      Github: https://github.com/adrianbj/ProcessPageFieldSelectCreator
       

    • By bernhard
      WHY?
      This module was built to fill the gap between simple $pages->find() operations and complex SQL queries.
      The problem with $pages->find() is that it loads all pages into memory and that can be a problem when querying multiple thousands of pages. Even $pages->findMany() loads all pages into memory and therefore is a lot slower than regular SQL.
      The problem with SQL on the other hand is, that the queries are quite complex to build. All fields are separate tables, some repeatable fields use multiple rows for their content that belong to only one single page, you always need to check for the page status (which is not necessary on regular find() operations and therefore nobody is used to that).
      In short: It is far too much work to efficiently and easily get an array of data based on PW pages and fields and I need that a lot for my RockGrid module to build all kinds of tabular data.

      Basic Usage

       
      Docs & Download
      https://modules.processwire.com/modules/rock-finder/
      https://github.com/BernhardBaumrock/RockFinder
       
      Changelog
      180817, v1.0.6, support for joining multiple finders 180810, v1.0.5, basic support for options fields 180528, v1.0.4, add custom select statement option 180516, change sql query method, bump version to 1.0.0 180515, multilang bugfix 180513, beta release <180513, preview/discussion took place here: https://processwire.com/talk/topic/18983-rocksqlfinder-highly-efficient-and-flexible-sql-finder-module/
    • By BitPoet
      MediaLibrary
      Update: MediaLibrary can now be found in the official module list.
      Out of necessity, I've started to implement a simple media library module.
      The basic mechanism is that it adds a MediaLibrary template with file and image fields. Pages of this type can be added anywhere in the page tree.
      The link and image pickers in CKEditor are extended to allow quick selection of library pages from dropdowns. In the link picker this happens in the MediaLibrary tab, where you can also see a preview of the selected image. In the image picker, simply select a library from the dropdown at the top, everything else is handled by standard functionality.
      I've put the code onto github. This module is compatible with ProcessWire 3.
      Steps to usage:
      Download the module's zip from github (switch to the pw3 branche beforehand if you want to test on PW 3.x) and unpack it into site/modules Click "Modules" -> "Refresh" in the admin Click "Install" for MediaLibrary For testing, create a page with the MediaLibrary template under home (give it an expressive title like 'Global Media') and add some images and files Edit a differnt page with a CKEditor field and add a link and an image to see the MediaLibrary features in action (see the screencap for details) Optionally, go into the module settings for MediaLibrary Note: this module is far from being as elaborate as Kongondo's Media Manager (and doesn't plan to be). If you need a feature-rich solution for integrated media management, give it a look.
      Feel free to change the settings for MediaFiles and MediaImages fields, just keep the type as multiple.
      There are some not-so-pretty hacks for creating and inserting the correct markup, which could probably be changed to use standard input fields, though I'm a bit at a loss right now how to get it to work. I've also still got to take a look at error handling before I can call it fit for production. All feedback and pointers are appreciated (that's also why I post this in the development section).

      Edit 09.03.2016 / version 0.0.4: there's now also a "Media" admin page with a shortcut to quickly add a new library.

      Edit 01.05.2016:
      Version 0.0.8:
      - The module now supports nested media libraries (all descendants of eligible media libraries are also selectable in link/image picker).
      - There's a MediaLibrary::getPageMediaLibraries method you can hook after to modify the array of available libraries.
      - You can switch between (default) select dropdowns or radio boxes in the module configuration of MediaLIbrary to choose libraries.
      Edit 10.10.2018:
      Version 0.1.3:
      - Dropped compatibility for ProcessWire legacy versions by adding namespaces
      - Allow deletion of libraries from the Media overview admin page
      - Added an option to hide media libraries from the page tree (optionally also for superusers)