Public API OC6 - what's missing

[DeepDiver1975]

This issue is to be used as a todo list for public apis which are missing as of today.
Please add a comment on what we miss and We will add this to the list below.

For each missing api a pull request is to be opened - once merged we can check the item on the todo list.

How to implement a public api?

1. Create an interface in the public namespace within lib/public which acts as the entry point for accessing the functionality e.g. https://github.com/owncloud/core/blob/master/lib/public/ipreview.php#L39
2. Add a getter to the IServerContainer - e.g. https://github.com/owncloud/core/blob/master/lib/public/iservercontainer.php#L64
3. Implement the api within the private namespace (core/lib/private) e.g.https://github.com/owncloud/core/blob/master/lib/private/previewmanager.php
4. Add the implementation of the getter to \OC\Server - please use the provided methods registerService() and query() because with this approach only those classes will be created which are going to be used
   

   core/lib/server.php

   Line 88 in 5d4e9e0

   return $this->query('PreviewManager');

   
   

   core/lib/server.php

   Line 49 in 5d4e9e0

   $this->registerService('PreviewManager', function($c){

Mainly important on all public classes, interfaces and methods: add proper PHPDoc comments

Missing apis

• file api - fixed with Provide an implementation of the fileapi for oc6 build on top of the old api #4712
• Avatar Add public API for \OC\Avatar #5040
• Config - Add a couple of interface definitions #4928
• Search
• OCP\App with getAppWebPath() & loadApps() - Public app interfaces #4919
• OC_FileProxy - see below
• OC_Cache - Public cache etc. #4886
• OC_Appconfig - is done with the config interface
• OC::getVersionString() - maybe define an interface IUtil?
• OC_App::disable() OC_App::enable() - coming in App interface #5069
• Session (and kill session from IRequest) - Public session #4888
• user and group managers
• OCS API
• template and related functions like nav menu - nav part in Add a couple of interface definitions #4928
• response sub classes
• AppFramework - add public api for middleware handling - music app has a nice show case for middleware usage
• Activity api - consumed by activity app
• UserSession for login and logout - Add a couple of interface definitions #4928
• ITaskScheduler and ITask
• IUtil / IHelper
• IEmitter
• EventSource. PHP side has been merged. JS side on standby
• ILog
• database - Add a couple of interface definitions #4928
• l10n
• Middleware registration in app container.
• \OCP\AppFramework\Utility\ControllerMethodReflector

[DeepDiver1975]

Regarding OC_FileProxy:

OC_FileProxy:

• $enabled
  Needed when reading and writing to storage obtained with
  \OCP\Files::getStorage('appName') when encryption is enabled.
  Maybe this can be done in the getStorage() call?

Thanks @tanghus

[DeepDiver1975]

@owncloud/core-developers One of the rare case where a notification to all seams legit 😉

[BernhardPosselt]

OC_Appconfig is needed only partly i think. Most of the useful stuff is in OCP\Config

[tanghus]

Session

Do we have a Session class? The PHP session is already available in Request.

(and kill session from IRequest)

Shouldn't that be separate from Request?

[DeepDiver1975]

Do we have a Session class?

https://github.com/owncloud/core/blob/master/lib/session/session.php - we need to create an interface from it

Shouldn't that be separate from Request?

Exactly - $_SESSION is available via the Request object - but this global var should not be used (actually it doesn't work in conjunction with our own session implementation)

[tanghus]

Ah, I was looking only in /lib, not the sub-folders.

Exactly - $_SESSION is available via the Request object - but this global var should not be used (actually it doesn't work in conjunction with our own session implementation)

Should it be removed from Request, changed to return an instance of ISession or...?

Edit: Now I read your previous comment again, and see that I misunderstood it. I thought you meant kill session as in destroy current session, so that answers my my own question ;)

[tanghus]

I think dogfooding is the best approach to iron out what's missing/inconvenient, but I can't quite grasp how to implement it in an app. What do I need to do to port an app from OCA\AppFramework?
Maybe the differences are smaller than I think :)

[tanghus]

More or less copy/paste from the ML:

Now in order to get the Files view you will have to do something like:

$root = $server->getRootFolder();
$files = $root->get('/files');

If so adding a getUserFolder() is a good idea. Maybe getRootFolder() should
return the view to /files, otherwise an app has access to other apps storage
area.
Then get app storage via getStorage()

Does Server know the current app? That would be very handy for e.g. getStorage.

[DeepDiver1975]

What do I need to do to port an app from OCA\AppFramework?
Maybe the differences are smaller than I think :)

That's another open topic and we need to add this to the documentation.
I will try to come up with an example pretty soon in order to show what it will look like.

I think dogfooding is the best approach to iron out what's missing/inconvenient

Exactly

[icewind1991]

If so adding a getUserFolder() is a good idea. Maybe getRootFolder() should
return the view to /files, otherwise an app has access to other apps storage
area.

getRootFolder should return the absolute root folder, there are more then enough valid use cases to access other apps' files.

Adding a getUserFolder is a good idea

[bartv2]

I'll take a stab at adding interfaces for the app calls

[DeepDiver1975]

Adding a getUserFolder is a good idea

Awaiting the pull request 😉

[DeepDiver1975]

I'll take a stab at adding interfaces for the app calls

thanks a lot!

[BernhardPosselt]

ideally you implement ArrayAccess for the session object so nothing should change compared to using $_SESSION

[tanghus]

Adding a getUserFolder is a good idea

Maybe:

• getUserFolder(): returns the root if the file view as in user/files
• getAppFolder(): returns a view specific to the app as in user/app. Basically an alias for OCP\Files::getStorage($app)

Awaiting the pull request 😉

I'm still befuddled by the filesystem, so I'm not sure of the proper way to do it.

[tanghus]

I will try to come up with an example pretty soon in order to show what it will look like.

Fantabulous :)

[icewind1991]

• getUserFolder(): returns the root if the file view as in user/files
• getAppFolder(): returns a view specific to the app as in user/app. Basically an alias for OCP\Files::getStorage($app)

👍

[tanghus]

getUserFolder(): returns the root if the file view as in user/files

Or getFilesFolder()?

[bartv2]

any comment on https://gist.github.com/bartv2/6586173

[bartv2]

@DeepDiver1975 i'm also missing a todo for the nav menu, or am i missing something. (this should go into the template namespace BTW)

[DeepDiver1975]

any comment on https://gist.github.com/bartv2/6586173

looks good

[DeepDiver1975]

i'm also missing a todo for the nav menu, or am i missing something. (this should go into the template namespace BTW)

task added - thx

[tanghus]

Shouldn't all Response subclasses be in the public namespace?

[DeepDiver1975]

Shouldn't all Response subclasses be in the public namespace?

yes - thanks for spotting - I missed this

[tanghus]

Shall I move them? What about the abstract controller class?

[DeepDiver1975]

Shall I move them?

hmm - json and template response are already part of the public namespace
lib/public/appframework/http

[tanghus]

Yes, only RedirectResponse and DownloadResponse missing. TextDownloadResponse has been killed? It also was a bit overkill to have a class just for a different mimetype.

[tanghus]

I added the interface to the middleware but there is no way to register the middleware within the container.

I still think having an abstract class would be sensible there :)

I need to add that ...

That would be great

[BernhardPosselt]

@tanghus the server container should not define any middleware at all. Actually i have no idea why its there

[tanghus]

@Raydiation

the server container should not define any middleware at all.

No that is in the app container.

[MorrisJobke]

OC::getVersionString() - maybe define an interface IUtil?
l10n

State of this?

I checked

template and related functions like nav menu - nav part in #4928
OC_Appconfig - is done with the config interface

because they are merged.

[karlitschek]

we are running out of time. let's move this to oC 7

[jancborchardt]

Did this make it into ownCloud 7 then, or do we need to triage? @karlitschek @DeepDiver1975

[MorrisJobke]

We nned to triage the above list again I think

[PVince81]

Anything here that could make it into OC 8 ?

[DeepDiver1975]

We need to review this once more and see how to continue - to some extent this also depends on requirements/requests from apps on which api they expect ...

[bboule]

I think we would want to consider things like planned splunk integration... This could be leverage in terms of reporting user clean up etc

@MTRichards thoughts?

Sent from my iPhone

On Nov 18, 2014, at 4:25 PM, Vincent Petry [email protected] wrote:

Anything here that could make it into OC 8 ?

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

[DeepDiver1975]

Time's up on this - please everybody: open individual issue for missing APIs - THX