Media model api #110

rjmackay · 2013-10-07T19:42:54Z

Initial implementation and getting myself up to speed with the current code base. So far:

Added media table with schema defined in the migration file 20131007103144.php
Added a media model.
Added media controller application/classes/Controller/Api/Media.php with some initial implementation for the various endpoints
Added test for media model

Next

Implement the actual file upload so it uploads the images to application/media/uploads
Look into adding migration script for images.
Write behat test to test the endpoints.
Look into wiring the media endpoints when creating a post.
Review feature

rjmackay · 2013-10-07T20:13:46Z

@eyedol I think this is mostly on the right track..

for thumbnails, etc.. I suggest we only store the original in the DB, and abstract the thumbnail/resize handling out to another library. I'm thinking we do something like the Drupal imagecache module, where you can request any image size you like and it generates + caches it.

This means themers can change thumbnail sizes etc as needed. You can happily delete all cached thumbnails at any time and they just get rebuilt when needed.

Could use something like: http://kohanaframework.org/3.3/guide/image/examples/dynamic or there might be something integrated with kohana-media already.
Whats the logic with storing the base image/media url in the db? are you just thinking ahead on CDN media hosting?

rjmackay · 2013-10-07T20:21:03Z

In fact this might work for serving image thumbnails etc: https://github.com/Bodom78/kohana-imagefly

eyedol · 2013-10-08T04:30:36Z

@rjmackay Imagefly seems like a great library though I can't figure out how I can, in code, fetch the various sizes that I want. As an API consumer, when I hit the media endpoint, I expect some re-resized images for my consumption, that was why I had the different sizes defined in the table.

Would be great if imagefly could resize images in code without url params, that way, when I fetch the original image from the db, I could use it for resizing to the different sizes for the API response. I'll play around with it and see.

The file_url was to accommodate media hosted on CDN and also to make it easier to get the location of the media. I think it makes more sense to just maintain the file_url and drop the filename field. So instead of the file_url being http://domain.com/media/upload/photos it becomes http://domain.com/media/upload/photos/51f75f03cb6fe1.02579520_o.jpg

brianherbert · 2013-10-08T04:33:36Z

If you guys end up doing dynamic image resizing on request, proceed with caution. It's very expensive to do in real time and also very difficult if you are serving media off a CDN.

rjmackay · 2013-10-08T08:21:29Z

@brianherbert Good point. Doing it in real-time can mostly be avoided.. but also if the resized image is cached it only has to happens once anyway. CDN is a more serious issue though.

kamaulynder · 2013-10-08T08:24:58Z

There was an email/post from Evan on this, as I scramble to find it. It was quite detailed.
On Oct 8, 2013, at 11:21 AM, Robbie MacKay wrote:

@brianherbert Good point. Doing it in real-time can mostly be avoided.. but also if the resized image is cached it only has to happens once anyway. CDN is a more serious issue though.

—
Reply to this email directly or view it on GitHub.

…have to be a json body

eyedol · 2013-10-09T15:53:12Z

Progress so far:

Implemented image upload to DOCROOT/uploads
Added basic validation when uploading an image. Images shouldn't be more than 1MB and they should be any of these types gif,jpg,jpeg,png
Added endpoints for uploading, fetching and deleting images.
Added initial documentation on the wiki

Write Behat test for the endpoints.
Look into migration script for media.

rjmackay · 2013-10-09T19:18:02Z

application/classes/Controller/Api/Media.php

+
+	protected $upload_dir;
+
+	public function before()


Why are we overriding before() ?

to initialize $this->upload_dir. I have removed this. The global scope of it is no longer needed as I'm moving the unlink call to the model class.

rjmackay · 2013-10-09T19:33:13Z

@Henry RE: "As an API consumer, when I hit the media endpoint, I expect some re-resized images for my consumption, that was why I had the different sizes defined in the table."
I agree.. I wasn't thinking about like an API function. Definitely provide a few sizes in the API.
The ideal would be

provide small, medium, large (and maybe original?) size in the API..
make these configurable through a config files.
Have some ability to generate them on the fly, in case sizes are changed after the fact.
Cache/Store any auto generated images to avoid doing that twice.
I'd prefer not to store resized images in the DB, just find them by naming convention, but think thats just my personal preference..

However do what you think makes sense given the CDN and API limitations.. we probably can't get all of these sorted.

Also agree on just maintaining file_url

rjmackay · 2013-10-09T19:34:13Z

application/classes/Controller/Api/Posts.php

@@ -2,7 +2,7 @@

 /**
 * Ushahidi API Posts Controller
- * 


Need to revert all the random whitespace changes in Posts and Sets before merge..

… media-model-api

…-model-api

rjmackay · 2013-10-18T09:11:56Z

README.md

@@ -108,7 +108,7 @@ git submodule update --init
 6. Edit ```application/config/environments/development/init.php``` and change base_url to point the the httpdocs directory in your deployment
 7. Copy ```httpdocs/template.htaccess``` to ```httpdocs/.htaccess```
 8. Edit ```httpdocs/.htaccess``` and change the RewriteBase value to match your deployment url
-9. Create directories ```application/cache``` and ```application/logs``` and make sure they're writeable by your webserver
+9. Create directories ```application/cache```, ```application/media/uploads``` and ```application/logs``` and make sure they're writeable by your webserver
    ```
    mkdir application/cache application/logs
    chown www-data application/cache application/logs


Can you update the example commands too?

rjmackay · 2013-10-18T09:15:06Z

application/config/imagefly.php

+    /**
+     * Path to the image cache directory you would like to use, don't forget the trailing slash!
+     */
+    'cache_dir'        => APPPATH.'cache/imagefly/',


any idea if this should be using DIRECTORY_SEPARATOR here?

DIRECTORY_SEPARATOR is not really necessary but a good practice. I also think it's future safe. Maybe not. I'll change the / to that instead for the sake of 'good practice'

…-model-api

rjmackay · 2013-10-18T09:18:16Z

I think this is done bar minor things.. fix the docs. make a call on the config. Merge it! 👍

Media model api

rjmackay · 2013-10-19T03:42:52Z

@eyedol is this: https://wiki.ushahidi.com/display/WIKI/Ushahidi+3.x+API+Media+Resource all up to date with the changes?

eyedol · 2013-10-19T13:11:05Z

Yes. Updated it with the changes. Mind a review?

* add toggle button to sidebar at data view page * fix angular json

eyedol added 4 commits October 7, 2013 20:31

Add media schema

e1fccb9

Add rules and validate of media data

8460300

Add ability to fetch all media and media by id:w

3a79de1

Add test cases for media model

b3d8da7

rjmackay mentioned this pull request Oct 7, 2013

Add media model and API #53

Closed

Minor fix to dataset

5e9e9fd

eyedol added 10 commits October 8, 2013 23:28

Add method for saving images to configured upload directory

b80132e

Add implementation for file upload and validation

4ed337c

Override default behaviour with request body so file uploads doesn't …

a6072ef

…have to be a json body

Add validations that are not handled in the model class

bc732c9

Save image details to db

ce068ce

Enabled image module

a8e769e

Save image to database

9a68178

Save caption to database

9208c07

Save file location to the database

5da5df4

Add deletion endpoint

27554b9

rjmackay reviewed Oct 9, 2013
View reviewed changes

eyedol and others added 13 commits October 18, 2013 14:50

Fix broken test

a42e3e8

Fix broken submodule clone

637a5ed

Remove imagefly module

6e733ff

Add info so directory needed by media api is created

bb04be3

Remove imagefly module entry

129b373

Add imagefly module

3076735

Add imagefly config file

9a03de1

Merge branch 'media-model-api' of git://github.com/ushahidi/Lamu into…

4db7f30

… media-model-api

Fix media config to make uploads land in application/media

c36894a

Fix media tests - urls have changed

2f19e45

Add gitignore for application/media/uploads

31f96a9

Minor edit

5484308

Merge branch 'media-model-api' of github.com:ushahidi/Lamu into media…

b77dcc5

…-model-api

rjmackay reviewed Oct 18, 2013
View reviewed changes

Simplify building media url, only build relative path once

89096c7

rjmackay reviewed Oct 18, 2013
View reviewed changes

Merge branch 'media-model-api' of github.com:ushahidi/Lamu into media…

4f78e5c

…-model-api

eyedol added 5 commits October 18, 2013 18:35

Update imagefly to make use of directory separator

9165f39

Add command for creating media uploads directories

adfd71c

Ignore files in media/uploads

8748b2e

Merge branch 'master' of github.com:ushahidi/Lamu

3ef5bb3

Fix conflict

a2789a5

eyedol added a commit that referenced this pull request Oct 18, 2013

Merge pull request #110 from ushahidi/media-model-api

12717e1

Media model api

eyedol merged commit 12717e1 into master Oct 18, 2013

rjmackay deleted the media-model-api branch November 4, 2013 22:21

nimishmedatwal pushed a commit to nimishmedatwal/platform that referenced this pull request Mar 11, 2024

[Ush-181] Sidebar filters show/hide (ushahidi#110)

71270d9

* add toggle button to sidebar at data view page * fix angular json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Media model api #110

Media model api #110

rjmackay commented Oct 7, 2013

rjmackay commented Oct 7, 2013

rjmackay commented Oct 7, 2013

eyedol commented Oct 8, 2013

brianherbert commented Oct 8, 2013

rjmackay commented Oct 8, 2013

kamaulynder commented Oct 8, 2013

eyedol commented Oct 9, 2013

rjmackay Oct 9, 2013

eyedol Oct 10, 2013

rjmackay commented Oct 9, 2013

rjmackay Oct 9, 2013

rjmackay Oct 18, 2013

rjmackay Oct 18, 2013

eyedol Oct 18, 2013

rjmackay commented Oct 18, 2013

rjmackay commented Oct 19, 2013

eyedol commented Oct 19, 2013

Media model api #110

Media model api #110

Conversation

rjmackay commented Oct 7, 2013

rjmackay commented Oct 7, 2013

rjmackay commented Oct 7, 2013

eyedol commented Oct 8, 2013

brianherbert commented Oct 8, 2013

rjmackay commented Oct 8, 2013

kamaulynder commented Oct 8, 2013

eyedol commented Oct 9, 2013

rjmackay Oct 9, 2013

Choose a reason for hiding this comment

eyedol Oct 10, 2013

Choose a reason for hiding this comment

rjmackay commented Oct 9, 2013

rjmackay Oct 9, 2013

Choose a reason for hiding this comment

rjmackay Oct 18, 2013

Choose a reason for hiding this comment

rjmackay Oct 18, 2013

Choose a reason for hiding this comment

eyedol Oct 18, 2013

Choose a reason for hiding this comment

rjmackay commented Oct 18, 2013

rjmackay commented Oct 19, 2013

eyedol commented Oct 19, 2013