API: add backward compatibility to API Version 11

This adds legacy support for the old API calls. This is mostly untested
but should work. Returns might not be 100% compatible in all cases but I
did

API: add backward compatibility to API Version 11

This adds legacy support for the old API calls. This is mostly untested
but should work. Returns might not be 100% compatible in all cases but I
did my best to return the same things as before.

This will be removed in the future of course and is just to not
completely break any API usage immeadiately.

show more ...

API: code style fixes

fix XMLRPC server tests

We test against the MockAPICore now since the tests are meant to ensure
the general functionality of accepting XML and correctly calling
APICalls works, not that the API retu

fix XMLRPC server tests

We test against the MockAPICore now since the tests are meant to ensure
the general functionality of accepting XML and correctly calling
APICalls works, not that the API returns the right things (this is
tested in the ApiCore tests).
Since we no longer use dates but always integers, we no longer need to
handle that.

show more ...

API: ApiCore tests fixed and extended

API: remove file and date transformations

We always deal with timestamps or base64 now. Removing some of the magic
makes everything less complex.

Only affected plugin is confmanager, which needs an

API: remove file and date transformations

We always deal with timestamps or base64 now. Removing some of the magic
makes everything less complex.

Only affected plugin is confmanager, which needs an update.

show more ...

moved OpenAPI generator to correct namespace

added missing doc blocks

Reworked API definition

This cleans up the API:

* no more compatibility with obsolete wiki API
* no more difference between wiki.* and dokuwiki.* calls -> core.*
* use of optional parameters avoids

Reworked API definition

This cleans up the API:

* no more compatibility with obsolete wiki API
* no more difference between wiki.* and dokuwiki.* calls -> core.*
* use of optional parameters avoids double definitions
* use Response objects for complex results
* always use named primitives as input
* major cleanup of docblock descriptions

show more ...

Fix first set of API tests

First go at refactoring the API mechanisms

This introduces an ApiCall class that wraps around the actual method
that produces the result. This replaces various loose array structures
that provided t

First go at refactoring the API mechanisms

This introduces an ApiCall class that wraps around the actual method
that produces the result. This replaces various loose array structures
that provided the meta information before.

The ApiCall streamlines the aggregation of meta information between core
and plugin methods. Now all data is produced by Reflection based
introspection. Certain aspects can be overridden if needed. See
ApiCore::getRemoteInfo() for examples

This change removes the _getMethods() method from remote plugins and
introduces a getMethods() method. The two are NOT compatible as the
latter now returns a list of ApiCalls. However when looking at the
existing plugins, it seems that _getMethods() was nearly 100% obsolete
with the Reflection based default implementation. So most plugins will
not be affected at all. Some might now export one or two more methods
than before because of poor visibility settings (eg. not declaring
private/protected methods as such).

This change removes the RPC_CALL_ADD hook. Only a single plugin ever
implemented it. I'm not sure what this hook was supposed to do anyway.
Being able to declare arbitrarily named API endpoints seems wrong to me
anyway.

The new ApiCall now also supports passing named instead of positional
parameters. This will open up a new opportunity to get a proper openapi
spec running.

Next step is fixing the tests.

show more ...

Merge pull request #3961 from dokuwiki/jsonrpc

Add JSON based alternative to XMLRPC

Use str_starts_with/str_ends_with

code style: line breaks

update some plugin classes in phpdocs, reformatting

recover comments in list

relax instance check in remoteAPI loading

This broke tests. Ideally an Interface should be defined that both the
real APICore and the TestPlugin implement.

Apply rector fixes to inc/Remote

fix line length issue

Add JSON based alternative to XMLRPC

XMLRPC is a rather outdated and old-fashioned protocol not much in use
anymore. Developers prefer simpler, JSON based APIs.

This adds a new "JSONRPC" API. Basic

Add JSON based alternative to XMLRPC

XMLRPC is a rather outdated and old-fashioned protocol not much in use
anymore. Developers prefer simpler, JSON based APIs.

This adds a new "JSONRPC" API. Basically it exposes exactly the same
method calls as the XMLRPC API but using JSON instead of XML. It's not a
classical REST API, but should be just as easy to use for developers.

Here is an example call using CURL:

curl http://localhost/dokuwiki/lib/exe/jsonrpc.phs \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $token" \
-d '["wiki"]'

Please note that the above uses the token auth implemented in #2432.
Authentication via basic auth or cookies would work as well.

show more ...

Update core code to make use of sexplode()

This makes use of our own explode mechanism everywhere were we expect a
fixed number of results.

Method names with leading double underscore are reserved by PHP.

fix method handling for RPC_CALL_ADD

This event seems not to be used by any plugin, which explains why this
bug hasn't surfaced yet. Access is always checked against a full method
name in the form o

fix method handling for RPC_CALL_ADD

This event seems not to be used by any plugin, which explains why this
bug hasn't surfaced yet. Access is always checked against a full method
name in the form of plugin.<pluginname>.<method> Such a full method was
not passed when using an event as described in the documentation.

show more ...

Fix various errors in PHPUnit tests on PHP 8

add alternative support for PHP not throwing ArgumentCountError in remote/APi

PHP 5.6 and 7.0 won't throw ArgumentCountError. In this case, we use
set_error_handler on E_WARNING and throw exceptions

add alternative support for PHP not throwing ArgumentCountError in remote/APi

PHP 5.6 and 7.0 won't throw ArgumentCountError. In this case, we use
set_error_handler on E_WARNING and throw exceptions if it's about argument
missing.

show more ...

catch ArgumentCountError and return XML error message for remoteAPI, fixes #2545

This is caused by a PHP 7.1 change:
https://www.php.net/manual/en/migration71.incompatible.php
#migration71.incompati

catch ArgumentCountError and return XML error message for remoteAPI, fixes #2545

This is caused by a PHP 7.1 change:
https://www.php.net/manual/en/migration71.incompatible.php
#migration71.incompatible.too-few-arguments-exception

Previously call_user_func_array will make those missing arguments
to NULL without throwing an exception.

show more ...

some more PSR2 cleanup

mostly overlong lines and more exclude patterns