--Friendica API\r
--===\r
--\r
--* [Home](help)\r
--\r
--The Friendica API aims to be compatible to the [GNU Social API](http://wiki.gnusocial.de/gnusocial:api) and the [Twitter API](https://dev.twitter.com/rest/public).\r
--\r
--Please refer to the linked documentation for further information.\r
--\r
--## Implemented API calls\r
--\r
--### General\r
--#### HTTP Method\r
--\r
--API endpoints can restrict the method used to request them.\r
--Using an invalid method results in HTTP error 405 "Method Not Allowed".\r
--\r
--In this document, the required method is listed after the endpoint name. "*" means every method can be used.\r
--\r
--#### Auth\r
--\r
--Friendica supports basic http auth and OAuth 1 to authenticate the user to the api.\r
--\r
--OAuth settings can be added by the user in web UI under /settings/oauth/\r
--\r
--In this document, endpoints which requires auth are marked with "AUTH" after endpoint name\r
--\r
--#### Unsupported parameters\r
--* cursor: Not implemented in GNU Social\r
--* trim_user: Not implemented in GNU Social\r
--* contributor_details: Not implemented in GNU Social\r
--* place_id: Not implemented in GNU Social\r
--* display_coordinates: Not implemented in GNU Social\r
--* include_rts: To-Do\r
--* include_my_retweet: Retweets in Friendica are implemented in a different way\r
--\r
--#### Different behaviour\r
--* screen_name: The nick name in friendica is only unique in each network but not for all networks. The users are searched in the following priority: Friendica, StatusNet/GNU Social, Diaspora, pump.io, Twitter. If no contact was found by this way, then the first contact is taken.\r
--* include_entities: Default is "false". If set to "true" then the plain text is formatted so that links are having descriptions.\r
--\r
--#### Return values\r
--* cid: Contact id of the user (important for "contact_allow" and "contact_deny")\r
--* network: network of the user\r
--\r
--#### Errors\r
--When an error occour in API call, an HTTP error code is returned, with an error message\r
--Usually:\r
--- 400 Bad Request: if parameter are missing or items can't be found\r
--- 403 Forbidden: if authenticated user is missing\r
--- 405 Method Not Allowed: if API was called with invalid method, eg. GET when API require POST\r
--- 501 Not Implemented: if requested API doesn't exists\r
--- 500 Internal Server Error: on other error contitions\r
--\r
--Error body is\r
--\r
--json:\r
--```\r
-- {\r
-- "error": "Specific error message",\r
-- "request": "API path requested",\r
-- "code": "HTTP error code"\r
-- }\r
--```\r
--\r
--xml:\r
--```\r
-- <status>\r
-- <error>Specific error message</error>\r
-- <request>API path requested</request>\r
-- <code>HTTP error code</code>\r
-- </status>\r
--```\r
--\r
-----\r
--### account/rate_limit_status (*; AUTH)\r
--\r
-----\r
--### account/verify_credentials (*; AUTH)\r
--#### Parameters\r
--\r
--* skip_status: Don't show the "status" field. (Default: false)\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
-----\r
--### conversation/show (*; AUTH)\r
--Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.\r
--\r
--#### Parameter\r
--* id: id of the post\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* include_rts\r
--* trim_user\r
--* contributor_details\r
--\r
-----\r
--### direct_messages (*; AUTH)\r
--#### Parameters\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* getText: Defines the format of the status field. Can be "html" or "plain"\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--* friendica_verbose: "true" enables different error returns (default: "false")\r
--\r
--#### Unsupported parameters\r
--* skip_status\r
--\r
-----\r
--### direct_messages/all (*; AUTH)\r
--#### Parameters\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* getText: Defines the format of the status field. Can be "html" or "plain"\r
--* friendica_verbose: "true" enables different error returns (default: "false")\r
--\r
-----\r
--### direct_messages/conversation (*; AUTH)\r
--Shows all direct messages of a conversation\r
--#### Parameters\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* getText: Defines the format of the status field. Can be "html" or "plain"\r
--* uri: URI of the conversation\r
--* friendica_verbose: "true" enables different error returns (default: "false")\r
--\r
-----\r
--### direct_messages/sent (*; AUTH)\r
--#### Parameters\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* getText: Defines the format of the status field. Can be "html" or "plain"\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--* friendica_verbose: "true" enables different error returns (default: "false")\r
--\r
-----\r
--### direct_messages/new (POST,PUT; AUTH)\r
--#### Parameters\r
--* user_id: id of the user\r
--* screen_name: screen name (for technical reasons, this value is not unique!)\r
--* text: The message\r
--* replyto: ID of the replied direct message\r
--* title: Title of the direct message\r
--\r
-----\r
--### direct_messages/destroy (POST,DELETE; AUTH)\r
--#### Parameters\r
--* id: id of the message to be deleted\r
--* include_entities: optional, currently not yet implemented\r
--* friendica_parenturi: optional, can be used for increased safety to delete only intended messages\r
--* friendica_verbose: "true" enables different error returns (default: "false")\r
--\r
--#### Return values\r
--\r
--On success:\r
--* JSON return as defined for Twitter API not yet implemented\r
--* on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}\r
--\r
--On error:\r
--HTTP 400 BadRequest\r
--* on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}\r
-\r
----\r
-### externalprofile/show (*)\r
-#### Parameters\r
-* profileurl: profile url\r
--\r
-----\r
--### favorites (*; AUTH)\r
--#### Parameters\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* user_id\r
--* screen_name\r
--\r
--Favorites aren't displayed to other users, so "user_id" and "screen_name" are unsupported.\r
--Set this values will result in an empty array.\r
--\r
-----\r
--### favorites/create (POST,PUT; AUTH)\r
--#### Parameters\r
--* id\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
-----\r
--### favorites/destroy (POST,DELETE; AUTH)\r
--#### Parameters\r
--* id\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
-----\r
--### followers/ids (*; AUTH)\r
--#### Parameters\r
--* stringify_ids: Should the id numbers be sent as text (true) or number (false)? (default: false)\r
--\r
--#### Unsupported parameters\r
--* user_id\r
--* screen_name\r
--* cursor\r
--\r
--Friendica doesn't allow showing followers of other users.\r
--\r
-----\r
--### friends/ids (*; AUTH)\r
--#### Parameters\r
--* stringify_ids: Should the id numbers be sent as text (true) or number (false)? (default: false)\r
--\r
--#### Unsupported parameters\r
--* user_id\r
--* screen_name\r
--* cursor\r
--\r
--Friendica doesn't allow showing friends of other users.\r
--\r
-----\r
--### help/test (*)\r
--\r
-----\r
--### media/upload (POST,PUT; AUTH)\r
--#### Parameters\r
--* media: image data\r
--\r
-----\r
--### oauth/request_token (*)\r
--#### Parameters\r
--* oauth_callback\r
--\r
--#### Unsupported parameters\r
--* x_auth_access_type\r
--\r
-----\r
--### oauth/access_token (*)\r
--#### Parameters\r
--* oauth_verifier\r
--\r
--#### Unsupported parameters\r
--* x_auth_password\r
--* x_auth_username\r
--* x_auth_mode\r
--\r
-----\r
--### statuses/destroy (POST,DELETE; AUTH)\r
--#### Parameters\r
--* id: message number\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* trim_user\r
--\r
-----\r
--### statuses/followers (*; AUTH)\r
--\r
--#### Parameters\r
--\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
-----\r
--### statuses/friends (*; AUTH)\r
--\r
--#### Parameters\r
--\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
-----\r
--### statuses/friends_timeline (*; AUTH)\r
--#### Parameters\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* exclude_replies: don't show replies (default: false)\r
--* conversation_id: Shows all statuses of a given conversation.\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* include_rts\r
--* trim_user\r
--* contributor_details\r
--\r
-----\r
--### statuses/home_timeline (*; AUTH)\r
--#### Parameters\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* exclude_replies: don't show replies (default: false)\r
--* conversation_id: Shows all statuses of a given conversation.\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* include_rts\r
--* trim_user\r
--* contributor_details\r
--\r
-----\r
--### statuses/mentions (*; AUTH)\r
--#### Parameters\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* include_rts\r
--* trim_user\r
--* contributor_details\r
--\r
-----\r
--### statuses/public_timeline (*; AUTH)\r
--#### Parameters\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* exclude_replies: don't show replies (default: false)\r
--* conversation_id: Shows all statuses of a given conversation.\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* trim_user\r
--\r
-----\r
--### statuses/replies (*; AUTH)\r
--#### Parameters\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* include_rts\r
--* trim_user\r
--* contributor_details\r
--\r
-----\r
--### statuses/retweet (POST,PUT; AUTH)\r
--#### Parameters\r
--* id: message number\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* trim_user\r
--\r
-----\r
--### statuses/show (*; AUTH)\r
--#### Parameters\r
--* id: message number\r
--* conversation: if set to "1" show all messages of the conversation with the given id\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* include_my_retweet\r
--* trim_user\r
--\r
-----\r
--### statuses/update, statuses/update_with_media\r
--#### Parameters\r
--* title: Title of the status\r
--* status: Status in text format\r
--* htmlstatus: Status in HTML format\r
--* in_reply_to_status_id\r
--* lat: latitude\r
--* long: longitude\r
--* media: image data\r
--* source: Application name\r
--* group_allow\r
--* contact_allow\r
--* group_deny\r
--* contact_deny\r
--* network\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--* media_ids: (By now only a single value, no array)\r
--\r
--#### Unsupported parameters\r
--* trim_user\r
--* place_id\r
--* display_coordinates\r
--\r
-----\r
--### statuses/user_timeline (*; AUTH)\r
--#### Parameters\r
--* user_id: id of the user\r
--* screen_name: screen name (for technical reasons, this value is not unique!)\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* exclude_replies: don't show replies (default: false)\r
--* conversation_id: Shows all statuses of a given conversation.\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--\r
--* include_rts\r
--* trim_user\r
--* contributor_details\r
--\r
-----\r
--### statusnet/config (*)\r
--\r
-----\r
--### statusnet/conversation (*; AUTH)\r
--It shows all direct answers (excluding the original post) to a given id.\r
--\r
--#### Parameter\r
--* id: id of the post\r
--* count: Items per page (default: 20)\r
--* page: page number\r
--* since_id: minimal id\r
--* max_id: maximum id\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
-----\r
--### statusnet/version (*)\r
--\r
--#### Unsupported parameters\r
--* user_id\r
--* screen_name\r
--* cursor\r
--\r
--Friendica doesn't allow showing followers of other users.\r
--\r
-----\r
--### users/search (*)\r
--#### Parameters\r
--* q: name of the user\r
--\r
--#### Unsupported parameters\r
--* page\r
--* count\r
--* include_entities\r
--\r
-----\r
--### users/show (*)\r
--#### Parameters\r
--* user_id: id of the user\r
--* screen_name: screen name (for technical reasons, this value is not unique!)\r
--* include_entities: "true" shows entities for pictures and links (Default: false)\r
--\r
--#### Unsupported parameters\r
--* user_id\r
--* screen_name\r
--* cursor\r
--\r
--Friendica doesn't allow showing friends of other users.\r
-\r
-\r
----\r
-### account/update_profile_image (POST; AUTH)\r
-#### Parameters\r
-* image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)\r
-* profile_id (optional): id of the profile for which the image should be used, default is changing the default profile\r
-\r
-uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo\r
-\r
-#### Return values\r
-\r
-On success:\r
-* JSON return: returns the updated user details (see account/verify_credentials)\r
-\r
-On error:\r
-* 403 FORBIDDEN: if not authenticated\r
-* 400 BADREQUEST: "no media data submitted", "profile_id not available"\r
-* 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server", \r
- "image size exceeds Friendica Config setting (uploaded size: x)", \r
- "unable to process image data", \r
- "image upload failed"\r
--\r
--\r
--## Implemented API calls (not compatible with other APIs)\r
--\r
--\r
-----\r
--### friendica/activity/<verb>\r
--#### parameters\r
--* id: item id\r
--\r
--Add or remove an activity from an item.\r
--'verb' can be one of:\r
--\r
--- like\r
--- dislike\r
--- attendyes\r
--- attendno\r
--- attendmaybe\r
--\r
--To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"\r
--Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".\r
--Attend verbs should be used only with event-related items (there is no check at the moment)\r
--\r
--#### Return values\r
--\r
--On success:\r
--json\r
--```"ok"```\r
--\r
--xml\r
--```<ok>true</ok>```\r
--\r
--On error:\r
--HTTP 400 BadRequest\r
--\r
-----\r
--### friendica/group_show (*; AUTH)\r
--Return all or a specified group of the user with the containing contacts as array.\r
--\r
--#### Parameters\r
--* gid: optional, if not given, API returns all groups of the user\r
--\r
--#### Return values\r
--Array of:\r
--\r
--* name: name of the group\r
--* gid: id of the group\r
--* user: array of group members (return from api_get_user() function for each member)\r
--\r
--\r
-----\r
--### friendica/group_delete (POST,DELETE; AUTH)\r
--delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.\r
--\r
--#### Parameters\r
--* gid: id of the group to be deleted\r
--* name: name of the group to be deleted\r
--\r
--#### Return values\r
--Array of:\r
--\r
--* success: true if successfully deleted\r
--* gid: gid of the deleted group\r
--* name: name of the deleted group\r
--* status: „deleted“ if successfully deleted\r
--* wrong users: empty array\r
--\r
--\r
-----\r
--### friendica/group_create (POST,PUT; AUTH)\r
--Create the group with the posted array of contacts as members.\r
--\r
--#### Parameters\r
--* name: name of the group to be created\r
--\r
--#### POST data\r
--JSON data as Array like the result of "users/group_show":\r
--\r
--* gid\r
--* name\r
--* array of users\r
--\r
--#### Return values\r
--Array of:\r
--\r
--* success: true if successfully created or reactivated\r
--* gid: gid of the created group\r
--* name: name of the created group\r
--* status: „missing user“ | „reactivated“ | „ok“\r
--* wrong users: array of users, which were not available in the contact table\r
--\r
--\r
-----\r
--### friendica/group_update (POST)\r
--Update the group with the posted array of contacts as members (post all members of the group to the call; function will remove members not posted).\r
--\r
--#### Parameters\r
--* gid: id of the group to be changed\r
--* name: name of the group to be changed\r
--\r
--#### POST data\r
--JSON data as array like the result of „users/group_show“:\r
--\r
--* gid\r
--* name\r
--* array of users\r
--\r
--#### Return values\r
--Array of:\r
--\r
--* success: true if successfully updated\r
--* gid: gid of the changed group\r
--* name: name of the changed group\r
--* status: „missing user“ | „ok“\r
--* wrong users: array of users, which were not available in the contact table\r
--\r
--\r
--\r
-----\r
--### friendica/notifications (GET)\r
--Return last 50 notification for current user, ordered by date with unseen item on top\r
--\r
--#### Parameters\r
--none\r
--\r
--#### Return values\r
--Array of:\r
--\r
--* id: id of the note\r
--* type: type of notification as int (see NOTIFY_* constants in boot.php)\r
--* name: full name of the contact subject of the note\r
--* url: contact's profile url\r
--* photo: contact's profile photo\r
--* date: datetime string of the note\r
--* timestamp: timestamp of the node\r
--* date_rel: relative date of the note (eg. "1 hour ago")\r
--* msg: note message in bbcode\r
--* msg_html: note message in html\r
--* msg_plain: note message in plain text\r
--* link: link to note\r
--* seen: seen state: 0 or 1\r
--\r
--\r
-----\r
--### friendica/notifications/seen (POST)\r
--Set note as seen, returns item object if possible\r
--\r
--#### Parameters\r
--id: id of the note to set seen\r
--\r
--#### Return values\r
--If the note is linked to an item, the item is returned, just like one of the "statuses/*_timeline" api.\r
--\r
--If the note is not linked to an item, a success status is returned:\r
--\r
--* "success" (json) | "<status>success</status>" (xml)\r
--\r
--\r
-----\r
--### friendica/photo (*; AUTH)\r
--#### Parameters\r
--* photo_id: Resource id of a photo.\r
--* scale: (optional) scale value of the photo\r
--\r
--Returns data of a picture with the given resource.\r
--If 'scale' isn't provided, returned data include full url to each scale of the photo.\r
--If 'scale' is set, returned data include image data base64 encoded.\r
--\r
--possibile scale value are:\r
--\r
--* 0: original or max size by server settings\r
--* 1: image with or height at <= 640\r
--* 2: image with or height at <= 320\r
--* 3: thumbnail 160x160\r
--* 4: Profile image at 175x175\r
--* 5: Profile image at 80x80\r
--* 6: Profile image at 48x48\r
--\r
--An image used as profile image has only scale 4-6, other images only 0-3\r
--\r
--#### Return values\r
--\r
--json\r
--```\r
-- {\r
-- "id": "photo id"\r
-- "created": "date(YYYY-MM-GG HH:MM:SS)",\r
-- "edited": "date(YYYY-MM-GG HH:MM:SS)",\r
-- "title": "photo title",\r
-- "desc": "photo description",\r
-- "album": "album name",\r
-- "filename": "original file name",\r
-- "type": "mime type",\r
-- "height": "number",\r
-- "width": "number",\r
-- "profile": "1 if is profile photo",\r
-- "link": {\r
-- "<scale>": "url to image"\r
-- ...\r
-- },\r
-- // if 'scale' is set\r
-- "datasize": "size in byte",\r
-- "data": "base64 encoded image data"\r
-- }\r
--```\r
--\r
--xml\r
--```\r
-- <photo>\r
-- <id>photo id</id>\r
-- <created>date(YYYY-MM-GG HH:MM:SS)</created>\r
-- <edited>date(YYYY-MM-GG HH:MM:SS)</edited>\r
-- <title>photo title</title>\r
-- <desc>photo description</desc>\r
-- <album>album name</album>\r
-- <filename>original file name</filename>\r
-- <type>mime type</type>\r
-- <height>number</height>\r
-- <width>number</width>\r
-- <profile>1 if is profile photo</profile>\r
-- <links type="array">\r
-- <link type="mime type" scale="scale number" href="image url"/>\r
-- ...\r
-- </links>\r
-- </photo>\r
--```\r
--\r
-----\r
--### friendica/photos/list (*; AUTH)\r
--\r
--Returns a list of all photo resources of the logged in user.\r
--\r
--#### Return values\r
--\r
--json\r
--```\r
-- [\r
-- {\r
-- id: "resource_id",\r
-- album: "album name",\r
-- filename: "original file name",\r
-- type: "image mime type",\r
-- thumb: "url to thumb sized image"\r
-- },\r
-- ...\r
-- ]\r
--```\r
--\r
--xml\r
--```\r
-- <photos type="array">\r
-- <photo id="resource_id"\r
-- album="album name"\r
-- filename="original file name"\r
-- type="image mime type">\r
-- "url to thumb sized image"\r
-- </photo>\r
-- ...\r
-- </photos>\r
--```\r
-\r
----\r
-### friendica/photoalbum/delete (POST,DELETE; AUTH)\r
-#### Parameters\r
-* album: name of the album to be deleted\r
-\r
-deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this\r
-\r
-#### Return values\r
-\r
-On success:\r
-* JSON return {"result":"deleted","message":"album 'xyz' with all containing photos has been deleted."}\r
-\r
-On error:\r
-* 403 FORBIDDEN: if not authenticated\r
-* 400 BADREQUEST: "no albumname specified", "album not available"\r
-* 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"\r
-\r
-\r
----\r
-### friendica/photoalbum/update (POST,PUT; AUTH)\r
-#### Parameters\r
-* album: name of the album to be updated\r
-* album_new: new name of the album\r
-\r
-changes the album name to album_new for all photos in album\r
-\r
-#### Return values\r
-\r
-On success:\r
-* JSON return {"result":"updated","message":"album 'abc' with all containing photos has been renamed to 'xyz'."}\r
-\r
-On error:\r
-* 403 FORBIDDEN: if not authenticated\r
-* 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"\r
-* 500 INTERNALSERVERERROR: "unknown error - updating in database failed"\r
-\r
-\r
----\r
-### friendica/photo/create (POST; AUTH)\r
-### friendica/photo/update (POST; AUTH)\r
-#### Parameters\r
-* photo_id (optional): if specified the photo with this id will be updated\r
-* media (optional): image data as base64, only optional if photo_id is specified (new upload must have media)\r
-* desc (optional): description for the photo, updated when photo_id is specified\r
-* album: name of the album to be deleted (always necessary)\r
-* album_new (optional): can be used to change the album of a single photo if photo_id is specified\r
-* allow_cid/allow_gid/deny_cid/deny_gid (optional): on create: empty string or omitting = public photo, specify in format '```<x><y><z>```' for private photo; \r
- on update: keys need to be present with empty values for setting a private photo now to public\r
-\r
-both calls point to one function for creating AND updating photos. \r
-Saves data for the scales 0-2 to database (see above for scale description). \r
-Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo. \r
-Client should pay attention to the fact that updated access rights are not transferred to the contacts. i.e. public photos remain publicly visible if they have been commented/liked before setting visibility back to a limited group.\r
-Currently it is best way to inform user that updating rights is not the best way, offer a solution to add photo as a new photo with the new rights. \r
-\r
-#### Return values\r
-\r
-On success:\r
-* new photo uploaded: JSON return with photo data (see friendica/photo)\r
-* photo updated - changed photo data: JSON return with photo data (see friendica/photo)\r
-* photo updated - changed info: JSON return {"result":"updated","message":"Image id 'xyz' has been updated."}\r
-* photo updated - nothing changed: JSON return {"result":"cancelled","message":"Nothing to update for image id 'xyz'."}\r
-\r
-On error:\r
-* 403 FORBIDDEN: if not authenticated\r
-* 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"\r
-* 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server", \r
- "image size exceeds Friendica Config setting (uploaded size: x)", \r
- "unable to process image data", \r
- "image upload failed", \r
- "unknown error - uploading photo failed, see Friendica log for more information", \r
- "unknown error - update photo entry in database failed", \r
- "unknown error - this error on uploading or updating a photo should never happen"\r
-\r
-\r
----\r
-### friendica/photo/delete (DELETE; AUTH)\r
-#### Parameters\r
-* photo_id: id of the photo to be deleted\r
-\r
-deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this\r
-Sets item table entries for this photo to deleted = 1\r
-\r
-#### Return values\r
-\r
-On success:\r
-* JSON return {"result":"deleted","message":"photo with id 'xyz' has been deleted from server."}\r
-\r
-On error:\r
-* 403 FORBIDDEN: if not authenticated\r
-* 400 BADREQUEST: "no photo_id specified", "photo not available"\r
-* 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"\r
-\r
--\r
-----\r
--### friendica/direct_messages_setseen (GET; AUTH)\r
--#### Parameters\r
--* id: id of the message to be updated as seen\r
--\r
--#### Return values\r
--\r
--On success:\r
--* JSON return {"result":"ok","message":"message set to seen"}\r
--\r
--On error:\r
--* different JSON returns {"result":"error","message":"xyz"}\r
--\r
-----\r
--### friendica/direct_messages_search (GET; AUTH)\r
--#### Parameters\r
--* searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)\r
--\r
--#### Return values\r
--Returns only tested with JSON, XML might work as well.\r
--\r
--On success:\r
--* JSON return {"success":"true","search_results": array of found messages}\r
--* JSOn return {"success":"false","search_results":"nothing found"}\r
--\r
--On error:\r
--* different JSON returns {"result":"error","message":"searchstring not specified"}\r
--\r
-----\r
--### friendica/profile/show (GET; AUTH)\r
--show data of all profiles or a single profile of the authenticated user\r
--\r
--#### Parameters\r
--* profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)\r
--\r
--#### Return values\r
--On success: Array of:\r
--\r
--* multi_profiles: true if user has activated multi_profiles\r
--* global_dir: URL of the global directory set in server settings\r
--* friendica_owner: user data of the authenticated user\r
--* profiles: array of the profile data\r
--\r
--On error: \r
--HTTP 403 Forbidden: when no authentication provided\r
--HTTP 400 Bad Request: if given profile_id is not in db or not assigned to authenticated user\r
--\r
--General description of profile data in API returns:\r
--* profile_id\r
--* profile_name\r
--* is_default: true if this is the public profile\r
--* hide_friends: true if friends are hidden\r
--* profile_photo\r
--* profile_thumb\r
--* publish: true if published on the server's local directory\r
--* net_publish: true if published to global_dir\r
--* description ... homepage: different data fields from 'profile' table in database\r
--* users: array with the users allowed to view this profile (empty if is_default=true)\r
--\r
--\r
-----\r
--## Not Implemented API calls\r
--The following API calls are implemented in GNU Social but not in Friendica: (incomplete)\r
--\r
--* statuses/retweets_of_me\r
--* friendships/create\r
--* friendships/destroy\r
--* friendships/exists\r
--* friendships/show\r
--* account/update_profile_background_image\r
- * account/update_profile_image\r
--* blocks/create\r
--* blocks/destroy\r
--\r
--The following API calls from the Twitter API aren't implemented neither in Friendica nor in GNU Social:\r
--\r
--* statuses/mentions_timeline\r
--* statuses/retweets/:id\r
--* statuses/oembed\r
--* statuses/retweeters/ids\r
--* statuses/lookup\r
--* direct_messages/show\r
--* search/tweets\r
--* friendships/no_retweets/ids\r
--* friendships/incoming\r
--* friendships/outgoing\r
--* friendships/update\r
--* friends/list\r
--* friendships/lookup\r
--* account/settings\r
--* account/update_delivery_device\r
--* account/update_profile\r
--* account/update_profile_background_image\r
- * account/update_profile_image\r
--* blocks/list\r
--* blocks/ids\r
--* users/lookup\r
--* users/show\r
--* users/search\r
--* account/remove_profile_banner\r
--* account/update_profile_banner\r
--* users/profile_banner\r
--* mutes/users/create\r
--* mutes/users/destroy\r
--* mutes/users/ids\r
--* mutes/users/list\r
--* users/suggestions/:slug\r
--* users/suggestions\r
--* users/suggestions/:slug/members\r
--* favorites/list\r
--* lists/list\r
--* lists/statuses\r
--* lists/members/destroy\r
--* lists/memberships\r
--* lists/subscribers\r
--* lists/subscribers/create\r
--* lists/subscribers/show\r
--* lists/subscribers/destroy\r
--* lists/members/create_all\r
--* lists/members/show\r
--* lists/members\r
--* lists/members/create\r
--* lists/destroy\r
--* lists/update\r
--* lists/create\r
--* lists/show\r
--* lists/subscriptions\r
--* lists/members/destroy_all\r
--* lists/ownerships\r
--* saved_searches/list\r
--* saved_searches/show/:id\r
--* saved_searches/create\r
--* saved_searches/destroy/:id\r
--* geo/id/:place_id\r
--* geo/reverse_geocode\r
--* geo/search\r
--* geo/place\r
--* trends/place\r
--* trends/available\r
--* help/configuration\r
--* help/languages\r
--* help/privacy\r
--* help/tos\r
--* trends/closest\r
--* users/report_spam\r
--\r
-----\r
--\r
-----\r
--\r
--## Usage Examples\r
--### BASH / cURL\r
--Betamax has documentated some example API usage from a [bash script](https://en.wikipedia.org/wiki/Bash_(Unix_shell) employing [curl](https://en.wikipedia.org/wiki/CURL) (see [his posting](https://betamax65.de/display/betamax65/43539)).\r
--\r
--/usr/bin/curl -u USER:PASS https://YOUR.FRIENDICA.TLD/api/statuses/update.xml -d source="some source id" -d status="the status you want to post"\r
--\r
--### Python\r
--The [RSStoFriedika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python. The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.\r
--\r
--def tweet(server, message, group_allow=None):\r
--url = server + '/api/statuses/update'\r
--urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))\r
--\r
--There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.\r
++Friendica API
++===
++
++* [Home](help)
++
++The Friendica API aims to be compatible to the [GNU Social API](http://wiki.gnusocial.de/gnusocial:api) and the [Twitter API](https://dev.twitter.com/rest/public).
++
++Please refer to the linked documentation for further information.
++
++## Implemented API calls
++
++### General
++#### HTTP Method
++
++API endpoints can restrict the method used to request them.
++Using an invalid method results in HTTP error 405 "Method Not Allowed".
++
++In this document, the required method is listed after the endpoint name. "*" means every method can be used.
++
++#### Auth
++
++Friendica supports basic http auth and OAuth 1 to authenticate the user to the api.
++
++OAuth settings can be added by the user in web UI under /settings/oauth/
++
++In this document, endpoints which requires auth are marked with "AUTH" after endpoint name
++
++#### Unsupported parameters
++* cursor: Not implemented in GNU Social
++* trim_user: Not implemented in GNU Social
++* contributor_details: Not implemented in GNU Social
++* place_id: Not implemented in GNU Social
++* display_coordinates: Not implemented in GNU Social
++* include_rts: To-Do
++* include_my_retweet: Retweets in Friendica are implemented in a different way
++
++#### Different behaviour
++* screen_name: The nick name in friendica is only unique in each network but not for all networks. The users are searched in the following priority: Friendica, StatusNet/GNU Social, Diaspora, pump.io, Twitter. If no contact was found by this way, then the first contact is taken.
++* include_entities: Default is "false". If set to "true" then the plain text is formatted so that links are having descriptions.
++
++#### Return values
++* cid: Contact id of the user (important for "contact_allow" and "contact_deny")
++* network: network of the user
++
++#### Errors
++When an error occour in API call, an HTTP error code is returned, with an error message
++Usually:
++- 400 Bad Request: if parameter are missing or items can't be found
++- 403 Forbidden: if authenticated user is missing
++- 405 Method Not Allowed: if API was called with invalid method, eg. GET when API require POST
++- 501 Not Implemented: if requested API doesn't exists
++- 500 Internal Server Error: on other error contitions
++
++Error body is
++
++json:
++```
++ {
++ "error": "Specific error message",
++ "request": "API path requested",
++ "code": "HTTP error code"
++ }
++```
++
++xml:
++```
++ <status>
++ <error>Specific error message</error>
++ <request>API path requested</request>
++ <code>HTTP error code</code>
++ </status>
++```
++
++---
++### account/rate_limit_status (*; AUTH)
++
++---
++### account/verify_credentials (*; AUTH)
++#### Parameters
++
++* skip_status: Don't show the "status" field. (Default: false)
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++---
++### conversation/show (*; AUTH)
++Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.
++
++#### Parameter
++* id: id of the post
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* include_rts
++* trim_user
++* contributor_details
++
++---
++### direct_messages (*; AUTH)
++#### Parameters
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* getText: Defines the format of the status field. Can be "html" or "plain"
++* include_entities: "true" shows entities for pictures and links (Default: false)
++* friendica_verbose: "true" enables different error returns (default: "false")
++
++#### Unsupported parameters
++* skip_status
++
++---
++### direct_messages/all (*; AUTH)
++#### Parameters
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* getText: Defines the format of the status field. Can be "html" or "plain"
++* friendica_verbose: "true" enables different error returns (default: "false")
++
++---
++### direct_messages/conversation (*; AUTH)
++Shows all direct messages of a conversation
++#### Parameters
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* getText: Defines the format of the status field. Can be "html" or "plain"
++* uri: URI of the conversation
++* friendica_verbose: "true" enables different error returns (default: "false")
++
++---
++### direct_messages/sent (*; AUTH)
++#### Parameters
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* getText: Defines the format of the status field. Can be "html" or "plain"
++* include_entities: "true" shows entities for pictures and links (Default: false)
++* friendica_verbose: "true" enables different error returns (default: "false")
++
++---
++### direct_messages/new (POST,PUT; AUTH)
++#### Parameters
++* user_id: id of the user
++* screen_name: screen name (for technical reasons, this value is not unique!)
++* text: The message
++* replyto: ID of the replied direct message
++* title: Title of the direct message
++
++---
++### direct_messages/destroy (POST,DELETE; AUTH)
++#### Parameters
++* id: id of the message to be deleted
++* include_entities: optional, currently not yet implemented
++* friendica_parenturi: optional, can be used for increased safety to delete only intended messages
++* friendica_verbose: "true" enables different error returns (default: "false")
++
++#### Return values
++
++On success:
++* JSON return as defined for Twitter API not yet implemented
++* on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}
++
++On error:
++HTTP 400 BadRequest
++* on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}
++
++---
++### externalprofile/show (*)
++#### Parameters
++* profileurl: profile url
++
++---
++### favorites (*; AUTH)
++#### Parameters
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* user_id
++* screen_name
++
++Favorites aren't displayed to other users, so "user_id" and "screen_name" are unsupported.
++Set this values will result in an empty array.
++
++---
++### favorites/create (POST,PUT; AUTH)
++#### Parameters
++* id
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++---
++### favorites/destroy (POST,DELETE; AUTH)
++#### Parameters
++* id
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++---
++### followers/ids (*; AUTH)
++#### Parameters
++* stringify_ids: Should the id numbers be sent as text (true) or number (false)? (default: false)
++
++#### Unsupported parameters
++* user_id
++* screen_name
++* cursor
++
++Friendica doesn't allow showing followers of other users.
++
++---
++### friends/ids (*; AUTH)
++#### Parameters
++* stringify_ids: Should the id numbers be sent as text (true) or number (false)? (default: false)
++
++#### Unsupported parameters
++* user_id
++* screen_name
++* cursor
++
++Friendica doesn't allow showing friends of other users.
++
++---
++### help/test (*)
++
++---
++### media/upload (POST,PUT; AUTH)
++#### Parameters
++* media: image data
++
++---
++### oauth/request_token (*)
++#### Parameters
++* oauth_callback
++
++#### Unsupported parameters
++* x_auth_access_type
++
++---
++### oauth/access_token (*)
++#### Parameters
++* oauth_verifier
++
++#### Unsupported parameters
++* x_auth_password
++* x_auth_username
++* x_auth_mode
++
++---
++### statuses/destroy (POST,DELETE; AUTH)
++#### Parameters
++* id: message number
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* trim_user
++
++---
++### statuses/followers (*; AUTH)
++
++#### Parameters
++
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++---
++### statuses/friends (*; AUTH)
++
++#### Parameters
++
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++---
++### statuses/friends_timeline (*; AUTH)
++#### Parameters
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* exclude_replies: don't show replies (default: false)
++* conversation_id: Shows all statuses of a given conversation.
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* include_rts
++* trim_user
++* contributor_details
++
++---
++### statuses/home_timeline (*; AUTH)
++#### Parameters
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* exclude_replies: don't show replies (default: false)
++* conversation_id: Shows all statuses of a given conversation.
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* include_rts
++* trim_user
++* contributor_details
++
++---
++### statuses/mentions (*; AUTH)
++#### Parameters
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* include_rts
++* trim_user
++* contributor_details
++
++---
++### statuses/public_timeline (*; AUTH)
++#### Parameters
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* exclude_replies: don't show replies (default: false)
++* conversation_id: Shows all statuses of a given conversation.
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* trim_user
++
++---
++### statuses/replies (*; AUTH)
++#### Parameters
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* include_rts
++* trim_user
++* contributor_details
++
++---
++### statuses/retweet (POST,PUT; AUTH)
++#### Parameters
++* id: message number
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* trim_user
++
++---
++### statuses/show (*; AUTH)
++#### Parameters
++* id: message number
++* conversation: if set to "1" show all messages of the conversation with the given id
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* include_my_retweet
++* trim_user
++
++---
++### statuses/update, statuses/update_with_media
++#### Parameters
++* title: Title of the status
++* status: Status in text format
++* htmlstatus: Status in HTML format
++* in_reply_to_status_id
++* lat: latitude
++* long: longitude
++* media: image data
++* source: Application name
++* group_allow
++* contact_allow
++* group_deny
++* contact_deny
++* network
++* include_entities: "true" shows entities for pictures and links (Default: false)
++* media_ids: (By now only a single value, no array)
++
++#### Unsupported parameters
++* trim_user
++* place_id
++* display_coordinates
++
++---
++### statuses/user_timeline (*; AUTH)
++#### Parameters
++* user_id: id of the user
++* screen_name: screen name (for technical reasons, this value is not unique!)
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* exclude_replies: don't show replies (default: false)
++* conversation_id: Shows all statuses of a given conversation.
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++
++* include_rts
++* trim_user
++* contributor_details
++
++---
++### statusnet/config (*)
++
++---
++### statusnet/conversation (*; AUTH)
++It shows all direct answers (excluding the original post) to a given id.
++
++#### Parameter
++* id: id of the post
++* count: Items per page (default: 20)
++* page: page number
++* since_id: minimal id
++* max_id: maximum id
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++---
++### statusnet/version (*)
++
++#### Unsupported parameters
++* user_id
++* screen_name
++* cursor
++
++Friendica doesn't allow showing followers of other users.
++
++---
++### users/search (*)
++#### Parameters
++* q: name of the user
++
++#### Unsupported parameters
++* page
++* count
++* include_entities
++
++---
++### users/show (*)
++#### Parameters
++* user_id: id of the user
++* screen_name: screen name (for technical reasons, this value is not unique!)
++* include_entities: "true" shows entities for pictures and links (Default: false)
++
++#### Unsupported parameters
++* user_id
++* screen_name
++* cursor
++
++Friendica doesn't allow showing friends of other users.
++
++
++---
++### account/update_profile_image (POST; AUTH)
++#### Parameters
++* image: image data as base64 (Twitter has a limit of 700kb, Friendica allows more)
++* profile_id (optional): id of the profile for which the image should be used, default is changing the default profile
++
++uploads a new profile image (scales 4-6) to database, changes default or specified profile to the new photo
++
++#### Return values
++
++On success:
++* JSON return: returns the updated user details (see account/verify_credentials)
++
++On error:
++* 403 FORBIDDEN: if not authenticated
++* 400 BADREQUEST: "no media data submitted", "profile_id not available"
++* 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
++ "image size exceeds Friendica Config setting (uploaded size: x)",
++ "unable to process image data",
++ "image upload failed"
++
++
++## Implemented API calls (not compatible with other APIs)
++
++
++---
++### friendica/activity/<verb>
++#### parameters
++* id: item id
++
++Add or remove an activity from an item.
++'verb' can be one of:
++
++- like
++- dislike
++- attendyes
++- attendno
++- attendmaybe
++
++To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
++Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
++Attend verbs should be used only with event-related items (there is no check at the moment)
++
++#### Return values
++
++On success:
++json
++```"ok"```
++
++xml
++```<ok>true</ok>```
++
++On error:
++HTTP 400 BadRequest
++
++---
++### friendica/group_show (*; AUTH)
++Return all or a specified group of the user with the containing contacts as array.
++
++#### Parameters
++* gid: optional, if not given, API returns all groups of the user
++
++#### Return values
++Array of:
++
++* name: name of the group
++* gid: id of the group
++* user: array of group members (return from api_get_user() function for each member)
++
++
++---
++### friendica/group_delete (POST,DELETE; AUTH)
++delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
++
++#### Parameters
++* gid: id of the group to be deleted
++* name: name of the group to be deleted
++
++#### Return values
++Array of:
++
++* success: true if successfully deleted
++* gid: gid of the deleted group
++* name: name of the deleted group
++* status: „deleted“ if successfully deleted
++* wrong users: empty array
++
++
++---
++### friendica/group_create (POST,PUT; AUTH)
++Create the group with the posted array of contacts as members.
++
++#### Parameters
++* name: name of the group to be created
++
++#### POST data
++JSON data as Array like the result of "users/group_show":
++
++* gid
++* name
++* array of users
++
++#### Return values
++Array of:
++
++* success: true if successfully created or reactivated
++* gid: gid of the created group
++* name: name of the created group
++* status: „missing user“ | „reactivated“ | „ok“
++* wrong users: array of users, which were not available in the contact table
++
++
++---
++### friendica/group_update (POST)
++Update the group with the posted array of contacts as members (post all members of the group to the call; function will remove members not posted).
++
++#### Parameters
++* gid: id of the group to be changed
++* name: name of the group to be changed
++
++#### POST data
++JSON data as array like the result of „users/group_show“:
++
++* gid
++* name
++* array of users
++
++#### Return values
++Array of:
++
++* success: true if successfully updated
++* gid: gid of the changed group
++* name: name of the changed group
++* status: „missing user“ | „ok“
++* wrong users: array of users, which were not available in the contact table
++
++
++
++---
++### friendica/notifications (GET)
++Return last 50 notification for current user, ordered by date with unseen item on top
++
++#### Parameters
++none
++
++#### Return values
++Array of:
++
++* id: id of the note
++* type: type of notification as int (see NOTIFY_* constants in boot.php)
++* name: full name of the contact subject of the note
++* url: contact's profile url
++* photo: contact's profile photo
++* date: datetime string of the note
++* timestamp: timestamp of the node
++* date_rel: relative date of the note (eg. "1 hour ago")
++* msg: note message in bbcode
++* msg_html: note message in html
++* msg_plain: note message in plain text
++* link: link to note
++* seen: seen state: 0 or 1
++
++
++---
++### friendica/notifications/seen (POST)
++Set note as seen, returns item object if possible
++
++#### Parameters
++id: id of the note to set seen
++
++#### Return values
++If the note is linked to an item, the item is returned, just like one of the "statuses/*_timeline" api.
++
++If the note is not linked to an item, a success status is returned:
++
++* "success" (json) | "<status>success</status>" (xml)
++
++
++---
++### friendica/photo (*; AUTH)
++#### Parameters
++* photo_id: Resource id of a photo.
++* scale: (optional) scale value of the photo
++
++Returns data of a picture with the given resource.
++If 'scale' isn't provided, returned data include full url to each scale of the photo.
++If 'scale' is set, returned data include image data base64 encoded.
++
++possibile scale value are:
++
++* 0: original or max size by server settings
++* 1: image with or height at <= 640
++* 2: image with or height at <= 320
++* 3: thumbnail 160x160
++* 4: Profile image at 175x175
++* 5: Profile image at 80x80
++* 6: Profile image at 48x48
++
++An image used as profile image has only scale 4-6, other images only 0-3
++
++#### Return values
++
++json
++```
++ {
++ "id": "photo id"
++ "created": "date(YYYY-MM-GG HH:MM:SS)",
++ "edited": "date(YYYY-MM-GG HH:MM:SS)",
++ "title": "photo title",
++ "desc": "photo description",
++ "album": "album name",
++ "filename": "original file name",
++ "type": "mime type",
++ "height": "number",
++ "width": "number",
++ "profile": "1 if is profile photo",
++ "link": {
++ "<scale>": "url to image"
++ ...
++ },
++ // if 'scale' is set
++ "datasize": "size in byte",
++ "data": "base64 encoded image data"
++ }
++```
++
++xml
++```
++ <photo>
++ <id>photo id</id>
++ <created>date(YYYY-MM-GG HH:MM:SS)</created>
++ <edited>date(YYYY-MM-GG HH:MM:SS)</edited>
++ <title>photo title</title>
++ <desc>photo description</desc>
++ <album>album name</album>
++ <filename>original file name</filename>
++ <type>mime type</type>
++ <height>number</height>
++ <width>number</width>
++ <profile>1 if is profile photo</profile>
++ <links type="array">
++ <link type="mime type" scale="scale number" href="image url"/>
++ ...
++ </links>
++ </photo>
++```
++
++---
++### friendica/photos/list (*; AUTH)
++
++Returns a list of all photo resources of the logged in user.
++
++#### Return values
++
++json
++```
++ [
++ {
++ id: "resource_id",
++ album: "album name",
++ filename: "original file name",
++ type: "image mime type",
++ thumb: "url to thumb sized image"
++ },
++ ...
++ ]
++```
++
++xml
++```
++ <photos type="array">
++ <photo id="resource_id"
++ album="album name"
++ filename="original file name"
++ type="image mime type">
++ "url to thumb sized image"
++ </photo>
++ ...
++ </photos>
++```
++
++---
++### friendica/photoalbum/delete (POST,DELETE; AUTH)
++#### Parameters
++* album: name of the album to be deleted
++
++deletes all images with the specified album name, is not reversible -> ensure that client is asking user for being sure to do this
++
++#### Return values
++
++On success:
++* JSON return {"result":"deleted","message":"album 'xyz' with all containing photos has been deleted."}
++
++On error:
++* 403 FORBIDDEN: if not authenticated
++* 400 BADREQUEST: "no albumname specified", "album not available"
++* 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
++
++
++---
++### friendica/photoalbum/update (POST,PUT; AUTH)
++#### Parameters
++* album: name of the album to be updated
++* album_new: new name of the album
++
++changes the album name to album_new for all photos in album
++
++#### Return values
++
++On success:
++* JSON return {"result":"updated","message":"album 'abc' with all containing photos has been renamed to 'xyz'."}
++
++On error:
++* 403 FORBIDDEN: if not authenticated
++* 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
++* 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
++
++
++---
++### friendica/photo/create (POST; AUTH)
++### friendica/photo/update (POST; AUTH)
++#### Parameters
++* photo_id (optional): if specified the photo with this id will be updated
++* media (optional): image data as base64, only optional if photo_id is specified (new upload must have media)
++* desc (optional): description for the photo, updated when photo_id is specified
++* album: name of the album to be deleted (always necessary)
++* album_new (optional): can be used to change the album of a single photo if photo_id is specified
++* allow_cid/allow_gid/deny_cid/deny_gid (optional): on create: empty string or omitting = public photo, specify in format '```<x><y><z>```' for private photo;
++ on update: keys need to be present with empty values for setting a private photo now to public
++
++both calls point to one function for creating AND updating photos.
++Saves data for the scales 0-2 to database (see above for scale description).
++Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo.
++Client should pay attention to the fact that updated access rights are not transferred to the contacts. i.e. public photos remain publicly visible if they have been commented/liked before setting visibility back to a limited group.
++Currently it is best way to inform user that updating rights is not the best way, offer a solution to add photo as a new photo with the new rights.
++
++#### Return values
++
++On success:
++* new photo uploaded: JSON return with photo data (see friendica/photo)
++* photo updated - changed photo data: JSON return with photo data (see friendica/photo)
++* photo updated - changed info: JSON return {"result":"updated","message":"Image id 'xyz' has been updated."}
++* photo updated - nothing changed: JSON return {"result":"cancelled","message":"Nothing to update for image id 'xyz'."}
++
++On error:
++* 403 FORBIDDEN: if not authenticated
++* 400 BADREQUEST: "no albumname specified", "no media data submitted", "photo not available", "acl data invalid"
++* 500 INTERNALSERVERERROR: "image size exceeds PHP config settings, file was rejected by server",
++ "image size exceeds Friendica Config setting (uploaded size: x)",
++ "unable to process image data",
++ "image upload failed",
++ "unknown error - uploading photo failed, see Friendica log for more information",
++ "unknown error - update photo entry in database failed",
++ "unknown error - this error on uploading or updating a photo should never happen"
++
++
++---
++### friendica/photo/delete (DELETE; AUTH)
++#### Parameters
++* photo_id: id of the photo to be deleted
++
++deletes a single image with the specified id, is not reversible -> ensure that client is asking user for being sure to do this
++Sets item table entries for this photo to deleted = 1
++
++#### Return values
++
++On success:
++* JSON return {"result":"deleted","message":"photo with id 'xyz' has been deleted from server."}
++
++On error:
++* 403 FORBIDDEN: if not authenticated
++* 400 BADREQUEST: "no photo_id specified", "photo not available"
++* 500 INTERNALSERVERERROR: "unknown error on deleting photo", "problem with deleting items occurred"
++
++
++---
++### friendica/direct_messages_setseen (GET; AUTH)
++#### Parameters
++* id: id of the message to be updated as seen
++
++#### Return values
++
++On success:
++* JSON return {"result":"ok","message":"message set to seen"}
++
++On error:
++* different JSON returns {"result":"error","message":"xyz"}
++
++---
++### friendica/direct_messages_search (GET; AUTH)
++#### Parameters
++* searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
++
++#### Return values
++Returns only tested with JSON, XML might work as well.
++
++On success:
++* JSON return {"success":"true","search_results": array of found messages}
++* JSOn return {"success":"false","search_results":"nothing found"}
++
++On error:
++* different JSON returns {"result":"error","message":"searchstring not specified"}
++
++---
++### friendica/profile/show (GET; AUTH)
++show data of all profiles or a single profile of the authenticated user
++
++#### Parameters
++* profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)
++
++#### Return values
++On success: Array of:
++
++* multi_profiles: true if user has activated multi_profiles
++* global_dir: URL of the global directory set in server settings
++* friendica_owner: user data of the authenticated user
++* profiles: array of the profile data
++
++On error:
++HTTP 403 Forbidden: when no authentication provided
++HTTP 400 Bad Request: if given profile_id is not in db or not assigned to authenticated user
++
++General description of profile data in API returns:
++* profile_id
++* profile_name
++* is_default: true if this is the public profile
++* hide_friends: true if friends are hidden
++* profile_photo
++* profile_thumb
++* publish: true if published on the server's local directory
++* net_publish: true if published to global_dir
++* description ... homepage: different data fields from 'profile' table in database
++* users: array with the users allowed to view this profile (empty if is_default=true)
++
++
++---
++## Not Implemented API calls
++The following API calls are implemented in GNU Social but not in Friendica: (incomplete)
++
++* statuses/retweets_of_me
++* friendships/create
++* friendships/destroy
++* friendships/exists
++* friendships/show
++* account/update_profile_background_image
++* blocks/create
++* blocks/destroy
++
++The following API calls from the Twitter API aren't implemented neither in Friendica nor in GNU Social:
++
++* statuses/mentions_timeline
++* statuses/retweets/:id
++* statuses/oembed
++* statuses/retweeters/ids
++* statuses/lookup
++* direct_messages/show
++* search/tweets
++* friendships/no_retweets/ids
++* friendships/incoming
++* friendships/outgoing
++* friendships/update
++* friends/list
++* friendships/lookup
++* account/settings
++* account/update_delivery_device
++* account/update_profile
++* account/update_profile_background_image
++* blocks/list
++* blocks/ids
++* users/lookup
++* users/show
++* users/search
++* account/remove_profile_banner
++* account/update_profile_banner
++* users/profile_banner
++* mutes/users/create
++* mutes/users/destroy
++* mutes/users/ids
++* mutes/users/list
++* users/suggestions/:slug
++* users/suggestions
++* users/suggestions/:slug/members
++* favorites/list
++* lists/list
++* lists/statuses
++* lists/members/destroy
++* lists/memberships
++* lists/subscribers
++* lists/subscribers/create
++* lists/subscribers/show
++* lists/subscribers/destroy
++* lists/members/create_all
++* lists/members/show
++* lists/members
++* lists/members/create
++* lists/destroy
++* lists/update
++* lists/create
++* lists/show
++* lists/subscriptions
++* lists/members/destroy_all
++* lists/ownerships
++* saved_searches/list
++* saved_searches/show/:id
++* saved_searches/create
++* saved_searches/destroy/:id
++* geo/id/:place_id
++* geo/reverse_geocode
++* geo/search
++* geo/place
++* trends/place
++* trends/available
++* help/configuration
++* help/languages
++* help/privacy
++* help/tos
++* trends/closest
++* users/report_spam
++
++---
++
++---
++
++## Usage Examples
++### BASH / cURL
++Betamax has documentated some example API usage from a [bash script](https://en.wikipedia.org/wiki/Bash_(Unix_shell) employing [curl](https://en.wikipedia.org/wiki/CURL) (see [his posting](https://betamax65.de/display/betamax65/43539)).
++
++/usr/bin/curl -u USER:PASS https://YOUR.FRIENDICA.TLD/api/statuses/update.xml -d source="some source id" -d status="the status you want to post"
++
++### Python
++The [RSStoFriedika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python. The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.
++
++def tweet(server, message, group_allow=None):
++url = server + '/api/statuses/update'
++urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))
++
++There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.
--Autoloader with Composer\r
--==========\r
--\r
--* [Home](help)\r
-- * [Developer Intro](help/Developers-Intro)\r
--\r
--Friendica uses [Composer](https://getcomposer.org) to manage dependencies libraries and the class autoloader both for libraries and namespaced Friendica classes.\r
--\r
--It's a command-line tool that downloads required libraries into the `vendor` folder and makes any namespaced class in `src` available through the whole application through `boot.php`.\r
--\r
--* [Using Composer](help/Composer)\r
--\r
--## A quick introduction to class autoloading\r
--\r
--The autoloader dynamically includes the file defining a class when it is first referenced, either by instantiating an object or simply making sure that it is available, without the need to explicitly use "require_once".\r
--\r
--Once it is set up you don't have to directly use it, you can directly use any class that is covered by the autoloader (currently `vendor` and `src`)\r
--\r
--Under the hood, Composer registers a callback with [`spl_autoload_register()`](http://php.net/manual/en/function.spl-autoload-register.php) that receives a class name as an argument and includes the corresponding class definition file.\r
--For more info about PHP autoloading, please refer to the [official PHP documentation](http://php.net/manual/en/language.oop5.autoload.php).\r
--\r
--### Example\r
--\r
--Let's say you have a PHP file in `src/` that define a very useful class:\r
--\r
--```php\r
- // src/ItemsManager.php\r
- <?php\r
- namespace \Friendica;\r
-// src/ItemsManager.php\r
-<?php\r
-namespace Friendica;\r
--\r
- class ItemsManager {\r
- public function getAll() { ... }\r
- public function getByID($id) { ... }\r
- }\r
-class ItemsManager {\r
- public function getAll() { ... }\r
- public function getByID($id) { ... }\r
-}\r
--```\r
--\r
--The class `ItemsManager` has been declared in the `Friendica` namespace.\r
--Namespaces are useful to keep classes separated and avoid names conflicts (could be that a library you want to use also defines a class named `ItemsManager`, but as long as it is in another namespace, you don't have any problem)\r
--\r
--Let's say now that you need to load some items in a view, maybe in a fictional `mod/network.php`.\r
--In order for the Composer autoloader to work, it must first be included. In Friendica this is already done at the top of `boot.php`, with `require_once('vendor/autoload.php');`.\r
--\r
--The code will be something like:\r
--\r
--```php\r
- // mod/network.php\r
- <?php\r
-// mod/network.php\r
-<?php\r
--\r
- function network_content(App $a) {\r
- $itemsmanager = new \Friendica\ItemsManager();\r
- $items = $itemsmanager->getAll();\r
-function network_content(App $a) {\r
- $itemsmanager = new Friendica\ItemsManager();\r
- $items = $itemsmanager->getAll();\r
--\r
- // pass $items to template\r
- // return result\r
- }\r
- // pass $items to template\r
- // return result\r
-}\r
--```\r
--\r
--That's a quite simple example, but look: no `require()`!\r
--If you need to use a class, you can simply use it and you don't need to do anything else.\r
--\r
--Going further: now we have a bunch of `*Manager` classes that cause some code duplication, let's define a `BaseManager` class, where we move all common code between all managers:\r
--\r
--```php\r
- // src/BaseManager.php\r
- <?php\r
- namespace \Friendica;\r
-// src/BaseManager.php\r
-<?php\r
-namespace Friendica;\r
--\r
- class BaseManager {\r
- public function thatFunctionEveryManagerUses() { ... }\r
- }\r
-class BaseManager {\r
- public function thatFunctionEveryManagerUses() { ... }\r
-}\r
--```\r
--\r
--and then let's change the ItemsManager class to use this code\r
--\r
--```php\r
- // src/ItemsManager.php\r
- <?php\r
- namespace \Friendica;\r
-// src/ItemsManager.php\r
-<?php\r
-namespace Friendica;\r
--\r
- class ItemsManager extends BaseManager {\r
- public function getAll() { ... }\r
- public function getByID($id) { ... }\r
- }\r
-class ItemsManager extends BaseManager {\r
- public function getAll() { ... }\r
- public function getByID($id) { ... }\r
-}\r
--```\r
--\r
--Even though we didn't explicitly include the `src/BaseManager.php` file, the autoloader will when this class is first defined, because it is referenced as a parent class.\r
--It works with the "BaseManager" example here and it works when we need to call static methods:\r
--\r
--```php\r
- // src/Dfrn.php\r
- <?php\r
- namespace \Friendica;\r
-// src/Dfrn.php\r
-<?php\r
-namespace Friendica;\r
--\r
- class Dfrn {\r
- public static function mail($item, $owner) { ... }\r
- }\r
-class Dfrn {\r
- public static function mail($item, $owner) { ... }\r
-}\r
--```\r
--\r
--```php\r
- // mod/mail.php\r
- <?php\r
-// mod/mail.php\r
-<?php\r
--\r
- mail_post($a){\r
- ...\r
- \Friendica\dfrn::mail($item, $owner);\r
- ...\r
- }\r
-mail_post($a){\r
- ...\r
- Friendica\dfrn::mail($item, $owner);\r
- ...\r
-}\r
--```\r
--\r
--If your code is in same namespace as the class you need, you don't need to prepend it:\r
--\r
--```php\r
- // include/delivery.php\r
- <?php\r
-// include/delivery.php\r
-<?php\r
--\r
- namespace \Friendica;\r
-namespace Friendica;\r
--\r
- // this is the same content of current include/delivery.php,\r
- // but has been declared to be in "Friendica" namespace\r
-// this is the same content of current include/delivery.php,\r
-// but has been declared to be in "Friendica" namespace\r
--\r
- [...]\r
- switch($contact['network']) {\r
- case NETWORK_DFRN:\r
- if ($mail) {\r
- $item['body'] = ...\r
- $atom = Dfrn::mail($item, $owner);\r
- } elseif ($fsuggest) {\r
- $atom = Dfrn::fsuggest($item, $owner);\r
- q("DELETE FROM `fsuggest` WHERE `id` = %d LIMIT 1", intval($item['id']));\r
- } elseif ($relocate)\r
- $atom = Dfrn::relocate($owner, $uid);\r
- [...]\r
-[...]\r
-switch($contact['network']) {\r
- case NETWORK_DFRN:\r
- if ($mail) {\r
- $item['body'] = ...\r
- $atom = Dfrn::mail($item, $owner);\r
- } elseif ($fsuggest) {\r
- $atom = Dfrn::fsuggest($item, $owner);\r
- q("DELETE FROM `fsuggest` WHERE `id` = %d LIMIT 1", intval($item['id']));\r
- } elseif ($relocate)\r
- $atom = Dfrn::relocate($owner, $uid);\r
-[...]\r
--```\r
--\r
--This is the current code of `include/delivery.php`, and since the code is declared to be in the "Friendica" namespace, you don't need to write it when you need to use the "Dfrn" class.\r
--But if you want to use classes from another library, you need to use the full namespace, e.g.\r
--\r
--```php\r
- // src/Diaspora.php\r
- <?php\r
-// src/Diaspora.php\r
-<?php\r
--\r
- namespace \Friendica;\r
-namespace Friendica;\r
--\r
- class Diaspora {\r
- public function md2bbcode() {\r
- $html = \Michelf\MarkdownExtra::defaultTransform($text);\r
- }\r
-class Diaspora {\r
- public function md2bbcode() {\r
- $html = \Michelf\MarkdownExtra::defaultTransform($text);\r
-- }\r
-}\r
--```\r
--\r
--if you use that class in many places of the code and you don't want to write the full path to the class every time, you can use the "use" PHP keyword\r
--\r
--```php\r
- // src/Diaspora.php\r
- <?php\r
- namespace \Friendica;\r
-// src/Diaspora.php\r
-<?php\r
-namespace Friendica;\r
--\r
- use \Michelf\MarkdownExtra;\r
-use \Michelf\MarkdownExtra;\r
--\r
- class Diaspora {\r
- public function md2bbcode() {\r
- $html = MarkdownExtra::defaultTransform($text);\r
- }\r
-class Diaspora {\r
- public function md2bbcode() {\r
- $html = MarkdownExtra::defaultTransform($text);\r
-- }\r
-}\r
--```\r
--\r
--Note that namespaces are like paths in filesystem, separated by "\", with the first "\" being the global scope.\r
--You can go deeper if you want to, like:\r
--\r
--```\r
- // src/Network/Dfrn.php\r
- <?php\r
- namespace \Friendica\Network;\r
-// src/Network/Dfrn.php\r
-<?php\r
-namespace Friendica\Network;\r
--\r
- class Dfrn {\r
- }\r
-class Dfrn {\r
-}\r
--```\r
--\r
- Please note that the location of the file defining the class must be placed in the appropriate sub-folders of `src` if the namespace isn't plain `\Friendica`.\r
-Please note that the location of the file defining the class must be placed in the appropriate sub-folders of `src` if the namespace isn't plain `Friendica`.\r
--\r
--or\r
--\r
--```\r
- // src/Dba/Mysql\r
- <?php\r
- namespace \Friendica\Dba;\r
-// src/Dba/Mysql\r
-<?php\r
-namespace Friendica\Dba;\r
--\r
- class Mysql {\r
- }\r
-class Mysql {\r
-}\r
--```\r
--\r
--So you can think of namespaces as folders in a Unix file system, with global scope as the root ("\").\r
-\r
-## Related\r
-\r
-* [Using Composer](help/Composer)\r
++Autoloader with Composer
++==========
++
++* [Home](help)
++ * [Developer Intro](help/Developers-Intro)
++
++Friendica uses [Composer](https://getcomposer.org) to manage dependencies libraries and the class autoloader both for libraries and namespaced Friendica classes.
++
++It's a command-line tool that downloads required libraries into the `vendor` folder and makes any namespaced class in `src` available through the whole application through `boot.php`.
++
++* [Using Composer](help/Composer)
++
++## A quick introduction to class autoloading
++
++The autoloader dynamically includes the file defining a class when it is first referenced, either by instantiating an object or simply making sure that it is available, without the need to explicitly use "require_once".
++
++Once it is set up you don't have to directly use it, you can directly use any class that is covered by the autoloader (currently `vendor` and `src`)
++
++Under the hood, Composer registers a callback with [`spl_autoload_register()`](http://php.net/manual/en/function.spl-autoload-register.php) that receives a class name as an argument and includes the corresponding class definition file.
++For more info about PHP autoloading, please refer to the [official PHP documentation](http://php.net/manual/en/language.oop5.autoload.php).
++
++### Example
++
++Let's say you have a PHP file in `src/` that define a very useful class:
++
++```php
++// src/ItemsManager.php
++<?php
++namespace Friendica;
++
++class ItemsManager {
++ public function getAll() { ... }
++ public function getByID($id) { ... }
++}
++```
++
++The class `ItemsManager` has been declared in the `Friendica` namespace.
++Namespaces are useful to keep classes separated and avoid names conflicts (could be that a library you want to use also defines a class named `ItemsManager`, but as long as it is in another namespace, you don't have any problem)
++
++Let's say now that you need to load some items in a view, maybe in a fictional `mod/network.php`.
++In order for the Composer autoloader to work, it must first be included. In Friendica this is already done at the top of `boot.php`, with `require_once('vendor/autoload.php');`.
++
++The code will be something like:
++
++```php
++// mod/network.php
++<?php
++
++function network_content(App $a) {
++ $itemsmanager = new Friendica\ItemsManager();
++ $items = $itemsmanager->getAll();
++
++ // pass $items to template
++ // return result
++}
++```
++
++That's a quite simple example, but look: no `require()`!
++If you need to use a class, you can simply use it and you don't need to do anything else.
++
++Going further: now we have a bunch of `*Manager` classes that cause some code duplication, let's define a `BaseManager` class, where we move all common code between all managers:
++
++```php
++// src/BaseManager.php
++<?php
++namespace Friendica;
++
++class BaseManager {
++ public function thatFunctionEveryManagerUses() { ... }
++}
++```
++
++and then let's change the ItemsManager class to use this code
++
++```php
++// src/ItemsManager.php
++<?php
++namespace Friendica;
++
++class ItemsManager extends BaseManager {
++ public function getAll() { ... }
++ public function getByID($id) { ... }
++}
++```
++
++Even though we didn't explicitly include the `src/BaseManager.php` file, the autoloader will when this class is first defined, because it is referenced as a parent class.
++It works with the "BaseManager" example here and it works when we need to call static methods:
++
++```php
++// src/Dfrn.php
++<?php
++namespace Friendica;
++
++class Dfrn {
++ public static function mail($item, $owner) { ... }
++}
++```
++
++```php
++// mod/mail.php
++<?php
++
++mail_post($a){
++ ...
++ Friendica\dfrn::mail($item, $owner);
++ ...
++}
++```
++
++If your code is in same namespace as the class you need, you don't need to prepend it:
++
++```php
++// include/delivery.php
++<?php
++
++namespace Friendica;
++
++// this is the same content of current include/delivery.php,
++// but has been declared to be in "Friendica" namespace
++
++[...]
++switch($contact['network']) {
++ case NETWORK_DFRN:
++ if ($mail) {
++ $item['body'] = ...
++ $atom = Dfrn::mail($item, $owner);
++ } elseif ($fsuggest) {
++ $atom = Dfrn::fsuggest($item, $owner);
++ q("DELETE FROM `fsuggest` WHERE `id` = %d LIMIT 1", intval($item['id']));
++ } elseif ($relocate)
++ $atom = Dfrn::relocate($owner, $uid);
++[...]
++```
++
++This is the current code of `include/delivery.php`, and since the code is declared to be in the "Friendica" namespace, you don't need to write it when you need to use the "Dfrn" class.
++But if you want to use classes from another library, you need to use the full namespace, e.g.
++
++```php
++// src/Diaspora.php
++<?php
++
++namespace Friendica;
++
++class Diaspora {
++ public function md2bbcode() {
++ $html = \Michelf\MarkdownExtra::defaultTransform($text);
++ }
++}
++```
++
++if you use that class in many places of the code and you don't want to write the full path to the class every time, you can use the "use" PHP keyword
++
++```php
++// src/Diaspora.php
++<?php
++namespace Friendica;
++
++use \Michelf\MarkdownExtra;
++
++class Diaspora {
++ public function md2bbcode() {
++ $html = MarkdownExtra::defaultTransform($text);
++ }
++}
++```
++
++Note that namespaces are like paths in filesystem, separated by "\", with the first "\" being the global scope.
++You can go deeper if you want to, like:
++
++```
++// src/Network/Dfrn.php
++<?php
++namespace Friendica\Network;
++
++class Dfrn {
++}
++```
++
++Please note that the location of the file defining the class must be placed in the appropriate sub-folders of `src` if the namespace isn't plain `Friendica`.
++
++or
++
++```
++// src/Dba/Mysql
++<?php
++namespace Friendica\Dba;
++
++class Mysql {
++}
++```
++
++So you can think of namespaces as folders in a Unix file system, with global scope as the root ("\").
++
++## Related
++
++* [Using Composer](help/Composer)
+ * [How To Move Classes to `src`](help/Developer-How-To-Move-Classes-to-src)
* @file include/identity.php
*/
-require_once('include/ForumManager.php');
-require_once('include/bbcode.php');
-require_once("mod/proxy.php");
-require_once('include/cache.php');
+ use Friendica\App;
+
+require_once 'include/ForumManager.php';
+require_once 'include/bbcode.php';
+require_once 'mod/proxy.php';
+require_once 'include/cache.php';
/**
*
// Pull out multiple headers, e.g. proxy and continuation headers
// allow for HTTP/2.x without fixing code
- while (preg_match('/^HTTP\/[1-2].+? [1-5][0-9][0-9]/',$base)) {
- $chunk = substr($base,0,strpos($base,"\r\n\r\n")+4);
+ while (preg_match('/^HTTP\/[1-2].+? [1-5][0-9][0-9]/', $base)) {
- $chunk = substr($base, 0, strpos($base, "\r\n\r\n") + 4);
++ $chunk = substr($base, 0, strpos($base,"\r\n\r\n") + 4);
$header .= $chunk;
- $base = substr($base,strlen($chunk));
+ $base = substr($base, strlen($chunk));
}
$a->set_curl_code($http_code);
if (preg_match('/(Location:|URI:)(.*?)\n/i', $header, $matches)) {
$newurl = trim(array_pop($matches));
}
- if (strpos($newurl,'/') === 0)
-
- if (strpos($newurl, '/') === 0) {
- $newurl = $old_location_info['scheme'] . '://' . $old_location_info['host'] . $newurl;
++ if (strpos($newurl,'/') === 0) {
+ $newurl = $old_location_info["scheme"]."://".$old_location_info["host"].$newurl;
+ }
+
if (filter_var($newurl, FILTER_VALIDATE_URL)) {
$redirects++;
@curl_close($ch);
$matches = array();
preg_match('/(Location:|URI:)(.*?)\n/', $header, $matches);
$newurl = trim(array_pop($matches));
- if (strpos($newurl,'/') === 0)
+
+ if (strpos($newurl, '/') === 0) {
- $newurl = $old_location_info['scheme'] . '://' . $old_location_info['host'] . $newurl;
+ $newurl = $old_location_info["scheme"] . "://" . $old_location_info["host"] . $newurl;
+ }
+
if (filter_var($newurl, FILTER_VALIDATE_URL)) {
$redirects++;
- logger("post_url: redirect ".$url." to ".$newurl);
- return post_url($newurl,$params, $headers, $redirects, $timeout);
- //return fetch_url($newurl,false,$redirects,$timeout);
+ logger('post_url: redirect ' . $url . ' to ' . $newurl);
+ return post_url($newurl, $params, $headers, $redirects, $timeout);
}
}
+
$a->set_curl_code($http_code);
- $body = substr($s,strlen($header));
+
+ $body = substr($s, strlen($header));
$a->set_curl_headers($header);
$host = strtolower($h['host']);
// always allow our own site
--
- if ($host == strtolower($_SERVER['SERVER_NAME']))
+ if ($host == strtolower($_SERVER['SERVER_NAME'])) {
return true;
+ }
$fnmatch = function_exists('fnmatch');
- $allowed = explode(',',$str_allowed);
+ $allowed = explode(',', $str_allowed);
if (count($allowed)) {
foreach ($allowed as $a) {
}
}
- $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `nurl` IN ('%s', '%s') AND `network` != '%s'",
- intval($importer["uid"]), dbesc(normalise_link($author["author-link"])),
- dbesc(normalise_link($aliaslink)), dbesc(NETWORK_STATUSNET));
- if (dbm::is_result($r)) {
- $contact = $r[0];
- $author["contact-id"] = $r[0]["id"];
- } else {
- $author["contact-id"] = $contact["id"];
+ $author["contact-id"] = $contact["id"];
+
+ if ($author["author-link"] != "") {
+ if ($aliaslink == "") {
+ $aliaslink = $author["author-link"];
+ }
+
+ $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `nurl` IN ('%s', '%s') AND `network` != '%s'",
+ intval($importer["uid"]), dbesc(normalise_link($author["author-link"])),
+ dbesc(normalise_link($aliaslink)), dbesc(NETWORK_STATUSNET));
++
+ if (dbm::is_result($r)) {
+ $contact = $r[0];
+ $author["contact-id"] = $r[0]["id"];
+ $author["author-link"] = $r[0]["url"];
+ }
+ } elseif ($addr != "") {
+ // Should not happen
+ $contact = dba::fetch_first("SELECT * FROM `contact` WHERE `uid` = ? AND `addr` = ? AND `network` != ?",
+ $importer["uid"], $addr, NETWORK_STATUSNET);
++
+ if (dbm::is_result($contact)) {
+ $author["contact-id"] = $contact["id"];
+ $author["author-link"] = $contact["url"];
+ }
}
$avatarlist = array();
--<?php\r
--\r
- /**\r
- * import account file exported from mod/uexport\r
- * args:\r
- * $a App Friendica App Class\r
- * $file Array array from $_FILES\r
- */\r
-use Friendica\App;\r
-\r
--require_once("include/Photo.php");\r
--define("IMPORT_DEBUG", False);\r
--\r
--function last_insert_id() {\r
-- global $db;\r
--\r
-- if (IMPORT_DEBUG)\r
-- return 1;\r
--\r
-- return $db->insert_id();\r
--}\r
--\r
--function last_error() {\r
-- global $db;\r
-- return $db->error;\r
--}\r
--\r
--/**\r
-- * Remove columns from array $arr that aren't in table $table\r
-- *\r
-- * @param string $table Table name\r
-- * @param array &$arr Column=>Value array from json (by ref)\r
-- */\r
--function check_cols($table, &$arr) {\r
-- $query = sprintf("SHOW COLUMNS IN `%s`", dbesc($table));\r
-- logger("uimport: $query", LOGGER_DEBUG);\r
-- $r = q($query);\r
-- $tcols = array();\r
-- // get a plain array of column names\r
-- foreach ($r as $tcol) {\r
-- $tcols[] = $tcol['Field'];\r
-- }\r
-- // remove inexistent columns\r
-- foreach ($arr as $icol => $ival) {\r
-- if (!in_array($icol, $tcols)) {\r
-- unset($arr[$icol]);\r
-- }\r
-- }\r
--}\r
--\r
--/**\r
-- * Import data into table $table\r
-- *\r
-- * @param string $table Table name\r
-- * @param array $arr Column=>Value array from json\r
-- */\r
--function db_import_assoc($table, $arr) {\r
-- if (isset($arr['id']))\r
-- unset($arr['id']);\r
-- check_cols($table, $arr);\r
-- $cols = implode("`,`", array_map('dbesc', array_keys($arr)));\r
-- $vals = implode("','", array_map('dbesc', array_values($arr)));\r
-- $query = "INSERT INTO `$table` (`$cols`) VALUES ('$vals')";\r
-- logger("uimport: $query", LOGGER_TRACE);\r
-- if (IMPORT_DEBUG)\r
-- return true;\r
-- return q($query);\r
--}\r
--\r
--function import_cleanup($newuid) {\r
-- q("DELETE FROM `user` WHERE uid = %d", $newuid);\r
-- q("DELETE FROM `contact` WHERE uid = %d", $newuid);\r
-- q("DELETE FROM `profile` WHERE uid = %d", $newuid);\r
-- q("DELETE FROM `photo` WHERE uid = %d", $newuid);\r
-- q("DELETE FROM `group` WHERE uid = %d", $newuid);\r
-- q("DELETE FROM `group_member` WHERE uid = %d", $newuid);\r
-- q("DELETE FROM `pconfig` WHERE uid = %d", $newuid);\r
--}\r
--\r
-/**\r
- * @brief Import account file exported from mod/uexport\r
- *\r
- * @param App $a Friendica App Class\r
- * @param array $file array from $_FILES\r
- */\r
--function import_account(App $a, $file) {\r
-- logger("Start user import from " . $file['tmp_name']);\r
-- /*\r
-- STEPS\r
-- 1. checks\r
-- 2. replace old baseurl with new baseurl\r
-- 3. import data (look at user id and contacts id)\r
-- 4. archive non-dfrn contacts\r
-- 5. send message to dfrn contacts\r
-- */\r
--\r
-- $account = json_decode(file_get_contents($file['tmp_name']), true);\r
-- if ($account === null) {\r
-- notice(t("Error decoding account file"));\r
-- return;\r
-- }\r
--\r
--\r
-- if (!x($account, 'version')) {\r
-- notice(t("Error! No version data in file! This is not a Friendica account file?"));\r
-- return;\r
-- }\r
--\r
-- /*\r
-- // this is not required as we remove columns in json not in current db schema\r
-- if ($account['schema'] != DB_UPDATE_VERSION) {\r
-- notice(t("Error! I can't import this file: DB schema version is not compatible."));\r
-- return;\r
-- }\r
-- */\r
--\r
-- // check for username\r
-- $r = q("SELECT uid FROM user WHERE nickname='%s'", $account['user']['nickname']);\r
-- if ($r === false) {\r
-- logger("uimport:check nickname : ERROR : " . last_error(), LOGGER_NORMAL);\r
-- notice(t('Error! Cannot check nickname'));\r
-- return;\r
-- }\r
-- if (dbm::is_result($r) > 0) {\r
-- notice(sprintf(t("User '%s' already exists on this server!"), $account['user']['nickname']));\r
-- return;\r
-- }\r
-- // check if username matches deleted account\r
-- $r = q("SELECT id FROM userd WHERE username='%s'", $account['user']['nickname']);\r
-- if ($r === false) {\r
-- logger("uimport:check nickname : ERROR : " . last_error(), LOGGER_NORMAL);\r
-- notice(t('Error! Cannot check nickname'));\r
-- return;\r
-- }\r
-- if (dbm::is_result($r) > 0) {\r
-- notice(sprintf(t("User '%s' already exists on this server!"), $account['user']['nickname']));\r
-- return;\r
-- }\r
--\r
-- $oldbaseurl = $account['baseurl'];\r
-- $newbaseurl = App::get_baseurl();\r
-- $olduid = $account['user']['uid'];\r
--\r
-- unset($account['user']['uid']);\r
-- unset($account['user']['account_expired']);\r
-- unset($account['user']['account_expires_on']);\r
-- unset($account['user']['expire_notification_sent']);\r
-- foreach ($account['user'] as $k => &$v) {\r
-- $v = str_replace($oldbaseurl, $newbaseurl, $v);\r
-- }\r
--\r
--\r
-- // import user\r
-- $r = db_import_assoc('user', $account['user']);\r
-- if ($r === false) {\r
-- //echo "<pre>"; var_dump($r, $query, mysql_error()); killme();\r
-- logger("uimport:insert user : ERROR : " . last_error(), LOGGER_NORMAL);\r
-- notice(t("User creation error"));\r
-- return;\r
-- }\r
-- $newuid = last_insert_id();\r
-- //~ $newuid = 1;\r
--\r
-- // Generate a new guid for the account. Otherwise there will be problems with diaspora\r
-- q("UPDATE `user` SET `guid` = '%s' WHERE `uid` = %d",\r
-- dbesc(generate_user_guid()), intval($newuid));\r
--\r
-- foreach ($account['profile'] as &$profile) {\r
-- foreach ($profile as $k => &$v) {\r
-- $v = str_replace($oldbaseurl, $newbaseurl, $v);\r
-- foreach (array("profile", "avatar") as $k)\r
-- $v = str_replace($oldbaseurl . "/photo/" . $k . "/" . $olduid . ".jpg", $newbaseurl . "/photo/" . $k . "/" . $newuid . ".jpg", $v);\r
-- }\r
-- $profile['uid'] = $newuid;\r
-- $r = db_import_assoc('profile', $profile);\r
-- if ($r === false) {\r
-- logger("uimport:insert profile " . $profile['profile-name'] . " : ERROR : " . last_error(), LOGGER_NORMAL);\r
-- info(t("User profile creation error"));\r
-- import_cleanup($newuid);\r
-- return;\r
-- }\r
-- }\r
--\r
-- $errorcount = 0;\r
-- foreach ($account['contact'] as &$contact) {\r
-- if ($contact['uid'] == $olduid && $contact['self'] == '1') {\r
-- foreach ($contact as $k => &$v) {\r
-- $v = str_replace($oldbaseurl, $newbaseurl, $v);\r
-- foreach (array("profile", "avatar", "micro") as $k)\r
-- $v = str_replace($oldbaseurl . "/photo/" . $k . "/" . $olduid . ".jpg", $newbaseurl . "/photo/" . $k . "/" . $newuid . ".jpg", $v);\r
-- }\r
-- }\r
-- if ($contact['uid'] == $olduid && $contact['self'] == '0') {\r
-- // set contacts 'avatar-date' to NULL_DATE to let poller to update urls\r
-- $contact["avatar-date"] = NULL_DATE;\r
--\r
--\r
-- switch ($contact['network']) {\r
-- case NETWORK_DFRN:\r
-- // send relocate message (below)\r
-- break;\r
-- case NETWORK_ZOT:\r
-- /// @TODO handle zot network\r
-- break;\r
-- case NETWORK_MAIL2:\r
-- /// @TODO ?\r
-- break;\r
-- case NETWORK_FEED:\r
-- case NETWORK_MAIL:\r
-- // Nothing to do\r
-- break;\r
-- default:\r
-- // archive other contacts\r
-- $contact['archive'] = "1";\r
-- }\r
-- }\r
-- $contact['uid'] = $newuid;\r
-- $r = db_import_assoc('contact', $contact);\r
-- if ($r === false) {\r
-- logger("uimport:insert contact " . $contact['nick'] . "," . $contact['network'] . " : ERROR : " . last_error(), LOGGER_NORMAL);\r
-- $errorcount++;\r
-- } else {\r
-- $contact['newid'] = last_insert_id();\r
-- }\r
-- }\r
-- if ($errorcount > 0) {\r
-- notice(sprintf(tt("%d contact not imported", "%d contacts not imported", $errorcount), $errorcount));\r
-- }\r
--\r
-- foreach ($account['group'] as &$group) {\r
-- $group['uid'] = $newuid;\r
-- $r = db_import_assoc('group', $group);\r
-- if ($r === false) {\r
-- logger("uimport:insert group " . $group['name'] . " : ERROR : " . last_error(), LOGGER_NORMAL);\r
-- } else {\r
-- $group['newid'] = last_insert_id();\r
-- }\r
-- }\r
--\r
-- foreach ($account['group_member'] as &$group_member) {\r
-- $group_member['uid'] = $newuid;\r
--\r
-- $import = 0;\r
-- foreach ($account['group'] as $group) {\r
-- if ($group['id'] == $group_member['gid'] && isset($group['newid'])) {\r
-- $group_member['gid'] = $group['newid'];\r
-- $import++;\r
-- break;\r
-- }\r
-- }\r
-- foreach ($account['contact'] as $contact) {\r
-- if ($contact['id'] == $group_member['contact-id'] && isset($contact['newid'])) {\r
-- $group_member['contact-id'] = $contact['newid'];\r
-- $import++;\r
-- break;\r
-- }\r
-- }\r
-- if ($import == 2) {\r
-- $r = db_import_assoc('group_member', $group_member);\r
-- if ($r === false) {\r
-- logger("uimport:insert group member " . $group_member['id'] . " : ERROR : " . last_error(), LOGGER_NORMAL);\r
-- }\r
-- }\r
-- }\r
- \r
- \r
- \r
- \r
--\r
-- foreach ($account['photo'] as &$photo) {\r
-- $photo['uid'] = $newuid;\r
-- $photo['data'] = hex2bin($photo['data']);\r
--\r
-- $p = new Photo($photo['data'], $photo['type']);\r
-- $r = $p->store(\r
-- $photo['uid'], $photo['contact-id'], //0\r
-- $photo['resource-id'], $photo['filename'], $photo['album'], $photo['scale'], $photo['profile'], //1\r
-- $photo['allow_cid'], $photo['allow_gid'], $photo['deny_cid'], $photo['deny_gid']\r
-- );\r
--\r
-- if ($r === false) {\r
-- logger("uimport:insert photo " . $photo['resource-id'] . "," . $photo['scale'] . " : ERROR : " . last_error(), LOGGER_NORMAL);\r
-- }\r
-- }\r
--\r
-- foreach ($account['pconfig'] as &$pconfig) {\r
-- $pconfig['uid'] = $newuid;\r
-- $r = db_import_assoc('pconfig', $pconfig);\r
-- if ($r === false) {\r
-- logger("uimport:insert pconfig " . $pconfig['id'] . " : ERROR : " . last_error(), LOGGER_NORMAL);\r
-- }\r
-- }\r
--\r
-- // send relocate messages\r
-- proc_run(PRIORITY_HIGH, 'include/notifier.php', 'relocate', $newuid);\r
--\r
-- info(t("Done. You can now login with your username and password"));\r
-- goaway(App::get_baseurl() . "/login");\r
--}\r
++<?php
++
++use Friendica\App;
++
++require_once("include/Photo.php");
++define("IMPORT_DEBUG", False);
++
++function last_insert_id() {
++ global $db;
++
++ if (IMPORT_DEBUG) {
++ return 1;
++ }
++
++ return $db->insert_id();
++}
++
++function last_error() {
++ global $db;
++ return $db->error;
++}
++
++/**
++ * Remove columns from array $arr that aren't in table $table
++ *
++ * @param string $table Table name
++ * @param array &$arr Column=>Value array from json (by ref)
++ */
++function check_cols($table, &$arr) {
++ $query = sprintf("SHOW COLUMNS IN `%s`", dbesc($table));
++ logger("uimport: $query", LOGGER_DEBUG);
++ $r = q($query);
++ $tcols = array();
++ // get a plain array of column names
++ foreach ($r as $tcol) {
++ $tcols[] = $tcol['Field'];
++ }
++ // remove inexistent columns
++ foreach ($arr as $icol => $ival) {
++ if (!in_array($icol, $tcols)) {
++ unset($arr[$icol]);
++ }
++ }
++}
++
++/**
++ * Import data into table $table
++ *
++ * @param string $table Table name
++ * @param array $arr Column=>Value array from json
++ */
++function db_import_assoc($table, $arr) {
++ if (isset($arr['id']))
++ unset($arr['id']);
++ check_cols($table, $arr);
++ $cols = implode("`,`", array_map('dbesc', array_keys($arr)));
++ $vals = implode("','", array_map('dbesc', array_values($arr)));
++ $query = "INSERT INTO `$table` (`$cols`) VALUES ('$vals')";
++ logger("uimport: $query", LOGGER_TRACE);
++ if (IMPORT_DEBUG) {
++ return true;
++ }
++ return q($query);
++}
++
++function import_cleanup($newuid) {
++ q("DELETE FROM `user` WHERE uid = %d", $newuid);
++ q("DELETE FROM `contact` WHERE uid = %d", $newuid);
++ q("DELETE FROM `profile` WHERE uid = %d", $newuid);
++ q("DELETE FROM `photo` WHERE uid = %d", $newuid);
++ q("DELETE FROM `group` WHERE uid = %d", $newuid);
++ q("DELETE FROM `group_member` WHERE uid = %d", $newuid);
++ q("DELETE FROM `pconfig` WHERE uid = %d", $newuid);
++}
++
++/**
++ * @brief Import account file exported from mod/uexport
++ *
++ * @param App $a Friendica App Class
++ * @param array $file array from $_FILES
++ */
++function import_account(App $a, $file) {
++ logger("Start user import from " . $file['tmp_name']);
++ /*
++ STEPS
++ 1. checks
++ 2. replace old baseurl with new baseurl
++ 3. import data (look at user id and contacts id)
++ 4. archive non-dfrn contacts
++ 5. send message to dfrn contacts
++ */
++
++ $account = json_decode(file_get_contents($file['tmp_name']), true);
++ if ($account === null) {
++ notice(t("Error decoding account file"));
++ return;
++ }
++
++
++ if (!x($account, 'version')) {
++ notice(t("Error! No version data in file! This is not a Friendica account file?"));
++ return;
++ }
++
++ /*
++ * @TODO Old-lost code?
++ // this is not required as we remove columns in json not in current db schema
++ if ($account['schema'] != DB_UPDATE_VERSION) {
++ notice(t("Error! I can't import this file: DB schema version is not compatible."));
++ return;
++ }
++ */
++
++ // check for username
++ $r = q("SELECT uid FROM user WHERE nickname='%s'", $account['user']['nickname']);
++ if ($r === false) {
++ logger("uimport:check nickname : ERROR : " . last_error(), LOGGER_NORMAL);
++ notice(t('Error! Cannot check nickname'));
++ return;
++ }
++ if (dbm::is_result($r) > 0) {
++ notice(sprintf(t("User '%s' already exists on this server!"), $account['user']['nickname']));
++ return;
++ }
++ // check if username matches deleted account
++ $r = q("SELECT id FROM userd WHERE username='%s'", $account['user']['nickname']);
++ if ($r === false) {
++ logger("uimport:check nickname : ERROR : " . last_error(), LOGGER_NORMAL);
++ notice(t('Error! Cannot check nickname'));
++ return;
++ }
++ if (dbm::is_result($r) > 0) {
++ notice(sprintf(t("User '%s' already exists on this server!"), $account['user']['nickname']));
++ return;
++ }
++
++ $oldbaseurl = $account['baseurl'];
++ $newbaseurl = App::get_baseurl();
++ $olduid = $account['user']['uid'];
++
++ unset($account['user']['uid']);
++ unset($account['user']['account_expired']);
++ unset($account['user']['account_expires_on']);
++ unset($account['user']['expire_notification_sent']);
++
++ foreach ($account['user'] as $k => &$v) {
++ $v = str_replace($oldbaseurl, $newbaseurl, $v);
++ }
++
++ // import user
++ $r = db_import_assoc('user', $account['user']);
++ if ($r === false) {
++ //echo "<pre>"; var_dump($r, $query, mysql_error()); killme();
++ logger("uimport:insert user : ERROR : " . last_error(), LOGGER_NORMAL);
++ notice(t("User creation error"));
++ return;
++ }
++ $newuid = last_insert_id();
++ //~ $newuid = 1;
++
++ // Generate a new guid for the account. Otherwise there will be problems with diaspora
++ q("UPDATE `user` SET `guid` = '%s' WHERE `uid` = %d",
++ dbesc(generate_user_guid()), intval($newuid));
++
++ foreach ($account['profile'] as &$profile) {
++ foreach ($profile as $k => &$v) {
++ $v = str_replace($oldbaseurl, $newbaseurl, $v);
++ foreach (array("profile", "avatar") as $k) {
++ $v = str_replace($oldbaseurl . "/photo/" . $k . "/" . $olduid . ".jpg", $newbaseurl . "/photo/" . $k . "/" . $newuid . ".jpg", $v);
++ }
++ }
++ $profile['uid'] = $newuid;
++ $r = db_import_assoc('profile', $profile);
++ if ($r === false) {
++ logger("uimport:insert profile " . $profile['profile-name'] . " : ERROR : " . last_error(), LOGGER_NORMAL);
++ info(t("User profile creation error"));
++ import_cleanup($newuid);
++ return;
++ }
++ }
++
++ $errorcount = 0;
++ foreach ($account['contact'] as &$contact) {
++ if ($contact['uid'] == $olduid && $contact['self'] == '1') {
++ foreach ($contact as $k => &$v) {
++ $v = str_replace($oldbaseurl, $newbaseurl, $v);
++ foreach (array("profile", "avatar", "micro") as $k) {
++ $v = str_replace($oldbaseurl . "/photo/" . $k . "/" . $olduid . ".jpg", $newbaseurl . "/photo/" . $k . "/" . $newuid . ".jpg", $v);
++ }
++ }
++ }
++ if ($contact['uid'] == $olduid && $contact['self'] == '0') {
++ // set contacts 'avatar-date' to NULL_DATE to let poller to update urls
++ $contact["avatar-date"] = NULL_DATE;
++
++ switch ($contact['network']) {
++ case NETWORK_DFRN:
++ // send relocate message (below)
++ break;
++ case NETWORK_ZOT:
++ /// @TODO handle zot network
++ break;
++ case NETWORK_MAIL2:
++ /// @TODO ?
++ break;
++ case NETWORK_FEED:
++ case NETWORK_MAIL:
++ // Nothing to do
++ break;
++ default:
++ // archive other contacts
++ $contact['archive'] = "1";
++ }
++ }
++ $contact['uid'] = $newuid;
++ $r = db_import_assoc('contact', $contact);
++ if ($r === false) {
++ logger("uimport:insert contact " . $contact['nick'] . "," . $contact['network'] . " : ERROR : " . last_error(), LOGGER_NORMAL);
++ $errorcount++;
++ } else {
++ $contact['newid'] = last_insert_id();
++ }
++ }
++ if ($errorcount > 0) {
++ notice(sprintf(tt("%d contact not imported", "%d contacts not imported", $errorcount), $errorcount));
++ }
++
++ foreach ($account['group'] as &$group) {
++ $group['uid'] = $newuid;
++ $r = db_import_assoc('group', $group);
++ if ($r === false) {
++ logger("uimport:insert group " . $group['name'] . " : ERROR : " . last_error(), LOGGER_NORMAL);
++ } else {
++ $group['newid'] = last_insert_id();
++ }
++ }
++
++ foreach ($account['group_member'] as &$group_member) {
++ $group_member['uid'] = $newuid;
++
++ $import = 0;
++ foreach ($account['group'] as $group) {
++ if ($group['id'] == $group_member['gid'] && isset($group['newid'])) {
++ $group_member['gid'] = $group['newid'];
++ $import++;
++ break;
++ }
++ }
++ foreach ($account['contact'] as $contact) {
++ if ($contact['id'] == $group_member['contact-id'] && isset($contact['newid'])) {
++ $group_member['contact-id'] = $contact['newid'];
++ $import++;
++ break;
++ }
++ }
++ if ($import == 2) {
++ $r = db_import_assoc('group_member', $group_member);
++ if ($r === false) {
++ logger("uimport:insert group member " . $group_member['id'] . " : ERROR : " . last_error(), LOGGER_NORMAL);
++ }
++ }
++ }
++
++ foreach ($account['photo'] as &$photo) {
++ $photo['uid'] = $newuid;
++ $photo['data'] = hex2bin($photo['data']);
++
++ $p = new Photo($photo['data'], $photo['type']);
++ $r = $p->store(
++ $photo['uid'], $photo['contact-id'], //0
++ $photo['resource-id'], $photo['filename'], $photo['album'], $photo['scale'], $photo['profile'], //1
++ $photo['allow_cid'], $photo['allow_gid'], $photo['deny_cid'], $photo['deny_gid']
++ );
++
++ if ($r === false) {
++ logger("uimport:insert photo " . $photo['resource-id'] . "," . $photo['scale'] . " : ERROR : " . last_error(), LOGGER_NORMAL);
++ }
++ }
++
++ foreach ($account['pconfig'] as &$pconfig) {
++ $pconfig['uid'] = $newuid;
++ $r = db_import_assoc('pconfig', $pconfig);
++ if ($r === false) {
++ logger("uimport:insert pconfig " . $pconfig['id'] . " : ERROR : " . last_error(), LOGGER_NORMAL);
++ }
++ }
++
++ // send relocate messages
++ proc_run(PRIORITY_HIGH, 'include/notifier.php', 'relocate', $newuid);
++
++ info(t("Done. You can now login with your username and password"));
++ goaway(App::get_baseurl() . "/login");
++}
<?php
+ use Friendica\App;
+
function login_content(App $a) {
- if(x($_SESSION,'theme'))
+ if (x($_SESSION, 'theme')) {
unset($_SESSION['theme']);
- if(x($_SESSION,'mobile-theme'))
+ }
++
+ if (x($_SESSION, 'mobile-theme')) {
unset($_SESSION['mobile-theme']);
+ }
- if(local_user())
+ if (local_user()) {
goaway(z_root());
- return login(($a->config['register_policy'] == REGISTER_CLOSED) ? false : true);
+ }
-
+
+ return login(($a->config['register_policy'] == REGISTER_CLOSED) ? false : true);
}
}
echo json_encode(array('img' => get_theme_screenshot($theme), 'desc' => $desc, 'version' => $version, 'credits' => $credits));
}
-
++
killme();
}
--<?php\r
-\r
--/**\r
-- * View for user import\r
- * @TODO This file has DOS line endings!\r
-- */\r
-\r
-use Friendica\App;\r
--\r
--require_once("include/uimport.php");\r
--\r
--function uimport_post(App $a) {\r
- switch($a->config['register_policy']) {\r
- case REGISTER_OPEN:\r
- $blocked = 0;\r
- $verified = 1;\r
- break;\r
- switch ($a->config['register_policy']) {\r
- case REGISTER_OPEN:\r
- $blocked = 0;\r
- $verified = 1;\r
- break;\r
--\r
- case REGISTER_APPROVE:\r
- $blocked = 1;\r
- $verified = 0;\r
- break;\r
- case REGISTER_APPROVE:\r
- $blocked = 1;\r
- $verified = 0;\r
- break;\r
--\r
- default:\r
- case REGISTER_CLOSED:\r
- if ((! x($_SESSION,'authenticated') && (! x($_SESSION,'administrator')))) {\r
- notice( t('Permission denied.') . EOL );\r
- return;\r
- }\r
- $blocked = 1;\r
- $verified = 0;\r
- break;\r
- default:\r
- case REGISTER_CLOSED:\r
- if ((!x($_SESSION, 'authenticated') && (!x($_SESSION, 'administrator')))) {\r
- notice(t('Permission denied.') . EOL);\r
- return;\r
- }\r
- $blocked = 1;\r
- $verified = 0;\r
- break;\r
-- }\r
--\r
- if (x($_FILES,'accountfile')){\r
- if (x($_FILES, 'accountfile')) {\r
-- /// @TODO Pass $blocked / $verified, send email to admin on REGISTER_APPROVE\r
-- import_account($a, $_FILES['accountfile']);\r
-- return;\r
-- }\r
--}\r
--\r
--function uimport_content(App $a) {\r
--\r
- if ((! local_user()) && ($a->config['register_policy'] == REGISTER_CLOSED)) {\r
- if ((!local_user()) && ($a->config['register_policy'] == REGISTER_CLOSED)) {\r
-- notice("Permission denied." . EOL);\r
-- return;\r
-- }\r
--\r
- $max_dailies = intval(get_config('system','max_daily_registrations'));\r
- $max_dailies = intval(get_config('system', 'max_daily_registrations'));\r
-- if ($max_dailies) {\r
-- $r = q("select count(*) as total from user where register_date > UTC_TIMESTAMP - INTERVAL 1 day");\r
-- if ($r && $r[0]['total'] >= $max_dailies) {\r
-- logger('max daily registrations exceeded.');\r
- notice( t('This site has exceeded the number of allowed daily account registrations. Please try again tomorrow.') . EOL);\r
- notice(t('This site has exceeded the number of allowed daily account registrations. Please try again tomorrow.') . EOL);\r
-- return;\r
-- }\r
-- }\r
--\r
--\r
- if (x($_SESSION,'theme')) {\r
- if (x($_SESSION, 'theme')) {\r
-- unset($_SESSION['theme']);\r
-- }\r
- if (x($_SESSION,'mobile-theme')) {\r
- if (x($_SESSION, 'mobile-theme')) {\r
-- unset($_SESSION['mobile-theme']);\r
-- }\r
--\r
-- $tpl = get_markup_template("uimport.tpl");\r
-- return replace_macros($tpl, array(\r
-- '$regbutt' => t('Import'),\r
-- '$import' => array(\r
- 'title' => t("Move account"),\r
- 'intro' => t("You can import an account from another Friendica server."),\r
- 'instruct' => t("You need to export your account from the old server and upload it here. We will recreate your old account here with all your contacts. We will try also to inform your friends that you moved here."),\r
- 'warn' => t("This feature is experimental. We can't import contacts from the OStatus network (GNU Social/Statusnet) or from Diaspora"),\r
- 'field' => array('accountfile', t('Account file'),'<input id="id_accountfile" name="accountfile" type="file">', t('To export your account, go to "Settings->Export your personal data" and select "Export account"')),\r
- 'title' => t("Move account"),\r
- 'intro' => t("You can import an account from another Friendica server."),\r
- 'instruct' => t("You need to export your account from the old server and upload it here. We will recreate your old account here with all your contacts. We will try also to inform your friends that you moved here."),\r
- 'warn' => t("This feature is experimental. We can't import contacts from the OStatus network (GNU Social/Statusnet) or from Diaspora"),\r
- 'field' => array('accountfile', t('Account file'), '<input id="id_accountfile" name="accountfile" type="file">', t('To export your account, go to "Settings->Export your personal data" and select "Export account"')),\r
-- ),\r
-- ));\r
--}\r
++<?php
++
++/**
++ * View for user import
++ */
++
++use Friendica\App;
++
++require_once("include/uimport.php");
++
++function uimport_post(App $a) {
++ switch ($a->config['register_policy']) {
++ case REGISTER_OPEN:
++ $blocked = 0;
++ $verified = 1;
++ break;
++
++ case REGISTER_APPROVE:
++ $blocked = 1;
++ $verified = 0;
++ break;
++
++ default:
++ case REGISTER_CLOSED:
++ if ((!x($_SESSION, 'authenticated') && (!x($_SESSION, 'administrator')))) {
++ notice(t('Permission denied.') . EOL);
++ return;
++ }
++ $blocked = 1;
++ $verified = 0;
++ break;
++ }
++
++ if (x($_FILES, 'accountfile')) {
++ /// @TODO Pass $blocked / $verified, send email to admin on REGISTER_APPROVE
++ import_account($a, $_FILES['accountfile']);
++ return;
++ }
++}
++
++function uimport_content(App $a) {
++
++ if ((!local_user()) && ($a->config['register_policy'] == REGISTER_CLOSED)) {
++ notice("Permission denied." . EOL);
++ return;
++ }
++
++ $max_dailies = intval(get_config('system', 'max_daily_registrations'));
++ if ($max_dailies) {
++ $r = q("select count(*) as total from user where register_date > UTC_TIMESTAMP - INTERVAL 1 day");
++ if ($r && $r[0]['total'] >= $max_dailies) {
++ logger('max daily registrations exceeded.');
++ notice(t('This site has exceeded the number of allowed daily account registrations. Please try again tomorrow.') . EOL);
++ return;
++ }
++ }
++
++
++ if (x($_SESSION, 'theme')) {
++ unset($_SESSION['theme']);
++ }
++ if (x($_SESSION, 'mobile-theme')) {
++ unset($_SESSION['mobile-theme']);
++ }
++
++ $tpl = get_markup_template("uimport.tpl");
++ return replace_macros($tpl, array(
++ '$regbutt' => t('Import'),
++ '$import' => array(
++ 'title' => t("Move account"),
++ 'intro' => t("You can import an account from another Friendica server."),
++ 'instruct' => t("You need to export your account from the old server and upload it here. We will recreate your old account here with all your contacts. We will try also to inform your friends that you moved here."),
++ 'warn' => t("This feature is experimental. We can't import contacts from the OStatus network (GNU Social/Statusnet) or from Diaspora"),
++ 'field' => array('accountfile', t('Account file'), '<input id="id_accountfile" name="accountfile" type="file">', t('To export your account, go to "Settings->Export your personal data" and select "Export account"')),
++ ),
++ ));
++}
--<!DOCTYPE html >\r
--<html itemscope itemtype="http://schema.org/Blog" lang="<?php echo $lang; ?>">\r
--<head>\r
-- <title><?php if(x($page,'title')) echo $page['title'] ?></title>\r
- <script>var baseurl="<?php echo App::get_baseurl() ?>";</script>\r
- <script>var baseurl="<?php echo Friendica\App::get_baseurl() ?>";</script>\r
-- <?php if(x($page,'htmlhead')) echo $page['htmlhead'] ?>\r
--</head>\r
--<body>\r
-- <?php if(x($page,'nav')) echo $page['nav']; ?>\r
-- <aside><?php if(x($page,'aside')) echo $page['aside']; ?></aside>\r
-- <section>\r
-- <?php if(x($page,'content')) echo $page['content']; ?>\r
-- <div id="pause"></div> <!-- The pause/resume Ajax indicator -->\r
-- <div id="page-footer"></div>\r
-- </section>\r
-- <right_aside><?php if(x($page,'right_aside')) echo $page['right_aside']; ?></right_aside>\r
-- <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>\r
--</body>\r
--</html>\r
++<!DOCTYPE html >
++<html itemscope itemtype="http://schema.org/Blog" lang="<?php echo $lang; ?>">
++<head>
++ <title><?php if(x($page,'title')) echo $page['title'] ?></title>
++ <script>var baseurl="<?php echo Friendica\App::get_baseurl() ?>";</script>
++ <?php if(x($page,'htmlhead')) echo $page['htmlhead'] ?>
++</head>
++<body>
++ <?php if(x($page,'nav')) echo $page['nav']; ?>
++ <aside><?php if(x($page,'aside')) echo $page['aside']; ?></aside>
++ <section>
++ <?php if(x($page,'content')) echo $page['content']; ?>
++ <div id="pause"></div> <!-- The pause/resume Ajax indicator -->
++ <div id="page-footer"></div>
++ </section>
++ <right_aside><?php if(x($page,'right_aside')) echo $page['right_aside']; ?></right_aside>
++ <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>
++</body>
++</html>
--<!DOCTYPE html >\r
--<html>\r
--<head>\r
-- <title><?php if(x($page,'title')) echo $page['title'] ?></title>\r
- <script>var baseurl="<?php echo App::get_baseurl() ?>";</script>\r
- <script>var baseurl="<?php echo Friendica\App::get_baseurl() ?>";</script>\r
-- <?php if(x($page,'htmlhead')) echo $page['htmlhead'] ?>\r
--</head>\r
--<body>\r
-- <section class="minimal" style="margin:0px!important; padding:0px!important; float:none!important;display:block!important;"><?php if(x($page,'content')) echo $page['content']; ?>\r
-- <div id="page-footer"></div>\r
-- </section>\r
--</body>\r
--</html>\r
--\r
++<!DOCTYPE html >
++<html>
++<head>
++ <title><?php if(x($page,'title')) echo $page['title'] ?></title>
++ <script>var baseurl="<?php echo Friendica\App::get_baseurl() ?>";</script>
++ <?php if(x($page,'htmlhead')) echo $page['htmlhead'] ?>
++</head>
++<body>
++ <section class="minimal" style="margin:0px!important; padding:0px!important; float:none!important;display:block!important;"><?php if(x($page,'content')) echo $page['content']; ?>
++ <div id="page-footer"></div>
++ </section>
++</body>
++</html>
<div class="group-delete-wrapper button" id="group-delete-wrapper-{{$id}}" >
-- <a href="group/drop/{{$id}}?t={{$form_security_token}}"
-- onclick="return confirmDelete();"
-- id="group-delete-icon-{{$id}}"
-- class="icon drophide group-delete-icon"
-- onmouseover="imgbright(this);"
- onmouseout="imgdull(this);" ></a>
- onmouseout="imgdull(this);"
++ <a href="group/drop/{{$id}}?t={{$form_security_token}}"
++ onclick="return confirmDelete();"
++ id="group-delete-icon-{{$id}}"
++ class="icon drophide group-delete-icon"
++ onmouseover="imgbright(this);"
++ onmouseout="imgdull(this);"
+ title="{{$delete}}">
+ </a>
</div>
<div class="group-delete-end"></div>
+ {{* Template for the contact group list *}}
+
+ {{* The contacts who are already members of the contact group *}}
<div id="group">
- <h3>{{$groupeditor.label_members}}</h3>
- <div id="group-members" class="contact_list">
- {{if $groupeditor.members }}
- {{foreach $groupeditor.members as $c}} {{$c}} {{/foreach}}
- {{else}}
- {{$groupeditor.group_is_empty}}
- {{/if}}
- </div>
- <div id="group-members-end"></div>
- <hr id="group-separator" />
+ <h3>{{$groupeditor.label_members}}</h3>
+ <div id="group-members" class="contact_list">
+
+ {{if $groupeditor.members }}
+
+ {{foreach $groupeditor.members as $c}}
+ {{* If there are too many contacts we use another view mode *}}
+ {{if $shortmode}}
+ <div class="contact-block-textdiv mpgroup">
+ <a class="contact-block-link mpgroup fakelink" target="redir" onclick="groupChangeMember({{$c.change_member.gid}},{{$c.change_member.cid}},'{{$c.change_member.sec_token}}'); return true;" title="{{$c.name}} [{{$c.itemurl}}]" alt="{{$c.name}}">
+ {{$c.name}}"
+ </a>
+ </div>
+ {{else}}
+ {{* The normal view mode *}}
+ <div class="contact-block-div mpgroup">
+ <a class="contact-block-link mpgroup fakelink" target="redir" onclick="groupChangeMember({{$c.change_member.gid}},{{$c.change_member.cid}},'{{$c.change_member.sec_token}}'); return true;">
+ <img class="contact-block-img mpgroup " src="{{$c.thumb}}" title="{{$c.name}} [{{$c.itemurl}}]" alt="{{$c.name}}">
+ </a>
+ </div>
+ {{/if}}
+ {{/foreach}}
+
+ {{else}}
+ {{$groupeditor.group_is_empty}}
+ {{/if}}
+ </div>
+
+ <div id="group-members-end"></div>
+ <hr id="group-separator" />
</div>
+ {{* The contacts who are not members of the contact group *}}
<div id="contacts">
- <h3>{{$groupeditor.label_contacts}}</h3>
- <div id="group-all-contacts" class="contact_list">
- {{foreach $groupeditor.contacts as $m}} {{$m}} {{/foreach}}
- </div>
- <div id="group-all-contacts-end"></div>
+ <h3>{{$groupeditor.label_contacts}}</h3>
+ <div id="group-all-contacts" class="contact_list">
+ {{foreach $groupeditor.contacts as $m}}
+ {{* If there are too many contacts we use another view mode *}}
+ {{if $shortmode}}
+ <div class="contact-block-textdiv mpall">
+ <a class="contact-block-link mpall fakelink" target="redir" onclick="groupChangeMember({{$m.change_member.gid}},{{$m.change_member.cid}},'{{$m.change_member.sec_token}}'); return true;" title="{{$m.name}} [{{$m.itemurl}}]" alt="{{$m.name}}">
+ {{$m.name}}
+ </a>
+ </div>
+ {{else}}
+ {{* The normal view mode *}}
+ <div class="contact-block-div mpall">
+ <a class="contact-block-link mpall fakelink" target="redir" onclick="groupChangeMember({{$m.change_member.gid}},{{$m.change_member.cid}},'{{$m.change_member.sec_token}}'); return true;">
+ <img class="contact-block-img mpall " src="{{$m.thumb}}" title="{{$m.name}} [{{$m.itemurl}}]" alt="{{$m.name}}">
+ </a>
+ </div>
+ {{/if}}
+ {{/foreach}}
+ </div>
+ <div id="group-all-contacts-end"></div>
</div>
-
--- /dev/null
-$(document).ready(function(){
+
+ /**
+ * @file view/theme/frio/js/mod_group.js
+ * @brief The javascript for the group module
+ */
+
+
- $("body").on("click", ".group-list-switcher", function(){
++$(document).ready(function() {
+ // Add an event listeners on buttons for switching the contact list view
- *
++ $("body").on("click", ".group-list-switcher", function() {
+ switchGroupViewMode(this);
+ });
+ });
+
+ /**
+ * @brief Change the group membership of the contacts and fetch the new grup list
+ * as html
- *
++ *
+ * @param {int} gid The group ID
+ * @param {int} cid The contact ID
+ * @param {string} sec_token The security token
- *
++ *
+ * @returns {undefined}
+ */
+ function groupChangeMember(gid, cid, sec_token) {
+ $("#contact-entry-wrapper-" + cid).fadeTo("fast", 0.33);
+ $(".tooltip").tooltip("hide");
+ $("body").css("cursor", "wait");
+
+ $.get('group/' + gid + '/' + cid + "?t=" + sec_token, function(data) {
+ // Insert the new group member list
+ $("#group-update-wrapper").html(data);
+
+ // Apply the actual gropu list view mode to the new
+ // group list html
+ var activeMode = $(".group-list-switcher.active");
+ switchGroupViewMode(activeMode[0]);
+
+ $("body").css("cursor", "auto");
+ });
+ }
+
+ /**
+ * @brief Change the group list view mode
- if (elm.id === "group-list-small") {
++ *
+ * @param {object} elm The button element of the view mode switcher
+ * @returns {undefined}
+ */
+ function switchGroupViewMode(elm) {
+ // Remove the active class from group list switcher buttons
+ $(".group-list-switcher").removeClass("active");
+ // And add it to the active button element
+ $(elm).addClass("active");
+
+ // Add or remove the css classes for the group list with regard to the active view mode
- *
++ if (elm.id === "group-list-small") {
+ $("#contact-group-list > li").addClass("shortmode col-lg-6 col-md-6 col-sm-6 col-xs-12");
+ } else {
+ $("#contact-group-list > li").removeClass("shortmode col-lg-6 col-md-6 col-sm-6 col-xs-12");
+ }
+ }
+
+ /**
+ * @brief Filter the group member list for contacts
++ *
+ * @returns {undefined}
+ */
+ function filterList() {
+ // Declare variables
+ var input, filter, ul, li, a, i;
+ input = document.getElementById("contacts-search");
+ filter = input.value.toUpperCase();
+ li = document.querySelectorAll("#contact-group-list>li");
+
+ // Loop through all list items, and hide those who don't match the search query
+ for (i = 0; i < li.length; i++) {
+ // Get the heading element
+ var mh = li[i].getElementsByClassName("media-heading")[0];
+ // The first child of the heading element should contain
+ // the text which we want to filter
+ a = mh.firstChild;
+ if (a.innerHTML.toUpperCase().indexOf(filter) > -1) {
+ li[i].style.display = "";
+ } else {
+ li[i].style.display = "none";
+ }
+ }
+ }
--- /dev/null
-
+ <script>
+ // update pending count //
+ $(function(){
+ $("nav").bind('nav-update', function(e,data){
+ var elm = $('#pending-update');
+ var register = $(data).find('register').text();
+ if (register=="0") { register = ""; }
+ elm.html(register);
+ });
+ });
+ </script>
+
+ <div class="widget">
+ <h3><a href="{{$admurl}}">{{$admtxt}}</a></h3>
+
+ <ul role="menu">
+ {{foreach $subpages as $name => $item}}
+ <li role="menuitem" class="{{$item.2}}">
+ <a href="{{$item.0}}" {{if $item.accesskey}}accesskey="{{$item.accesskey}}"{{/if}}>
+ {{$item.1}}
+ {{if $name == "users"}}
+ <span id="pending-update" class="badge pull-right"></span>
+ {{/if}}
+ </a>
+ </li>
+ {{/foreach}}
+ </ul>
+
+ {{if $admin.update}}
+ <ul role="menu">
+ <li role="menuitem" class="{{$admin.update.2}}">
+ <a href="{{$admin.update.0}}" {{if $admin.update.accesskey}}accesskey="{{$admin.update.accesskey}}"{{/if}}>
+ {{$admin.update.1}}
+ </a>
+ </li>
+ </ul>
+ {{/if}}
+ </div>
+
+ {{if $admin.plugins_admin}}
+ <div class="widget">
+ <h3>{{$plugadmtxt}}</h3>
+ <ul role="menu">
+ {{foreach $admin.plugins_admin as $name => $item}}
+ <li role="menuitem" class="{{$item.2}}">
+ <a href="{{$item.0}}" {{if $item.accesskey}}accesskey="{{$item.accesskey}}"{{/if}}>
+ {{$item.1}}
+ </a>
+ </li>
+ {{/foreach}}
+ </ul>
+ </div>
+ {{/if}}
+
+ <div class="widget">
+ <h3>{{$logtxt}}</h3>
+ <ul role="menu">
+ <li role="menuitem" class="{{$admin.logs.2}}">
+ <a href="{{$admin.logs.0}}" {{if $admin.logs.accesskey}}accesskey="{{$admin.logs.accesskey}}"{{/if}}>
+ {{$admin.logs.1}}
+ </a>
+ </li>
+ <li role="menuitem" class="{{$admin.viewlogs.2}}">
+ <a href="{{$admin.viewlogs.0}}" {{if $admin.viewlogs.accesskey}}accesskey="{{$admin.viewlogs.accesskey}}"{{/if}}>
+ {{$admin.viewlogs.1}}
+ </a>
+ </li>
+ </ul>
+ </div>
+
+ <div class="widget">
+ <h3>{{$diagnosticstxt}}</h3>
+ <ul role="menu">
+ <li role="menuitem" class="{{$admin.diagnostics_probe.2}}">
+ <a href="{{$admin.diagnostics_probe.0}}" {{if $admin.diagnostics_probe.accesskey}}accesskey="{{$admin.diagnostics_probe.accesskey}}"{{/if}}>
+ {{$admin.diagnostics_probe.1}}
+ </a>
+ </li>
+ <li role="menuitem" class="{{$admin.diagnostics_webfinger.2}}">
+ <a href="{{$admin.diagnostics_webfinger.0}}" {{if $admin.viewlogs.accesskey}}accesskey="{{$admin.diagnostics_webfinger.accesskey}}"{{/if}}>
+ {{$admin.diagnostics_webfinger.1}}
+ </a>
+ </li>
+ </ul>
+ </div>
--- /dev/null
-{{* This template is for the "group" module. It provides the user the possibility to
+
- <input type="text"
- name="filter"
- id="contacts-search"
- class="search-input form-control form-search"
- onkeyup="filterList(); return false;"
++{{* This template is for the "group" module. It provides the user the possibility to
+ modify a specific contact group (remove contact group, edit contact group name,
+ add or remove contacts to the contact group.
+ *}}
+
+ <script type="text/javascript" src="view/theme/frio/js/mod_group.js"></script>
+
+ <div class="generic-page-wrapper">
+
+ {{* The buttons for editing the contact group (edit name / remove contact group) *}}
+ <div class="group-actions pull-right">
+ <button type="button" id="group-rename" class="btn btn-clear" onclick="openClose('group-edit-wrapper'); return false;" title="{{$edit_name}}" data-toggle="tooltip">
+ <i class="fa fa-pencil" aria-hidden="true"></i>
+ </button>
+ {{if $drop}}{{$drop}}{{/if}}
+ </div>
+
+ {{include file="section_title.tpl"}}
+
+ {{* Edit the name of the group *}}
+ <div id="group-edit-wrapper" class="panel panel-inline">
+ <form action="group/{{$gid}}" id="group-edit-form" method="post">
+ <input type='hidden' name='form_security_token' value='{{$form_security_token}}'>
+
+ {{include file="field_input.tpl" field=$gname}}
+ <div id="group-edit-submit-wrapper" class="form-group pull-right">
+ <button class="btn btn-primary btn-small" type="submit" name="submit" value="{{$submit|escape:'html'}}">
+ {{$submit|escape:'html'}}
+ </button>
+ </div>
+ <div id="group-edit-select-end" class="clear"></div>
+ </form>
+ </div>
+
+ {{* The search input field to search for contacts *}}
+ <div id="contacts-search-wrapper">
+ <div id="contacts-search-form" class="navbar-form" role="search">
+ <div class="row">
+ <div class="col-md-2"></div>
+ <div class="col-md-8 ">
+ <div class="form-group form-group-search">
++ <input type="text"
++ name="filter"
++ id="contacts-search"
++ class="search-input form-control form-search"
++ onkeyup="filterList(); return false;"
+ onfocus="this.select(); return false;"
+ />
+ </div>
+ </div>
+ <div class="col-md-2"></div>
+ </div>
+ </div>
+ </div>
+
+ <hr>
+ <div id="contacts-search-end"></div>
+
+ {{if $groupeditor}}
+ {{* The buttons to switch between the different view modes *}}
+ <div id="group-list-view-switcher" class="btn-group btn-group-sm pull-right">
+ <botton type="button" id="group-list-big" class="active group-list-switcher btn btn-default">
+ <i class="fa fa-align-justify" aria-hidden="true"></i>
+ </botton>
+ <button type="button" id="group-list-small" class="btn btn-default group-list-switcher">
+ <i class="fa fa-th-large" aria-hidden="true"></i>
+ </button>
+ </div>
+ <div class="clear"></div>
+
+ {{* The contact group list *}}
+ <div id="group-update-wrapper">
+ {{include file="groupeditor.tpl"}}
+ </div>
+ {{/if}}
+ </div>
--- /dev/null
- {{foreach $groupeditor.members as $contact}}
+
+ {{* Template for the contact group list *}}
+ <div id="group" class="contact_list">
+
+ <ul id="contact-group-list" class="viewcontact_wrapper media-list">
+
+ {{* The contacts who are already members of the contact group *}}
++ {{foreach $groupeditor.members as $contact}}
+ <li class="members active">{{include file="contact_template.tpl"}}</li>
+ {{/foreach}}
+
+ {{* The contacts who are not members of the contact group *}}
+ {{foreach $groupeditor.contacts as $contact}}
+ <li class="contacts">{{include file="contact_template.tpl"}}</li>
+ {{/foreach}}
+
+ </ul>
+ <div class="clear"></div>
+ </div>
--<!DOCTYPE html >\r
--<html lang="<?php echo $lang; ?>">\r
--<head>\r
-- <title><?php if(x($page,'title')) echo $page['title'] ?></title>\r
- <script>var baseurl="<?php echo App::get_baseurl() ?>";</script>\r
- <script>var baseurl="<?php echo Friendica\App::get_baseurl() ?>";</script>\r
-- <?php if(x($page,'htmlhead')) echo $page['htmlhead'] ?>\r
--</head>\r
--<body <?php if($a->module === 'home') echo 'onLoad="setTimeout(\'homeRedirect()\', 1500)"'?>>\r
-- <?php if(x($page,'nav')) echo $page['nav']; ?>\r
--\r
-- <?php if( $a->module === 'home' ) { ?>\r
-- <center>\r
-- <div class="login-button">\r
-- <a href="login" class="login-button-link"><img class="login-button-image" src="images/friendica-1600.png" title="Click to log in"></a>\r
-- </div>\r
-- </center>\r
--\r
-- <?php } elseif ( $a->module === 'login' || $a->module === 'register' || $a->module === 'lostpass' ) {\r
-- ?>\r
-- <div class='section-wrapper'>\r
-- <section><?php if(x($page,'content')) echo $page['content']; ?>\r
-- </section>\r
-- </div>\r
-- <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>\r
--\r
-- <?php } else { ?>\r
-- <div class='main-container'>\r
--<!-- <div class='main-content-container'>-->\r
-- <div class='section-wrapper'>\r
-- <?php if( ($a->module === 'settings' || $a->module === 'message' || $a->module === 'profile') && x($page,'aside')) echo $page['aside']; ?>\r
-- <section>\r
-- <?php if(x($page,'content')) echo $page['content']; ?>\r
-- <div id="pause"></div> <!-- The pause/resume Ajax indicator -->\r
-- <div id="page-footer"></div>\r
-- </section>\r
-- </div>\r
-- <right_aside><?php if(x($page,'right_aside')) echo $page['right_aside']; ?></right_aside>\r
-- <?php if( ($a->module === 'contacts') && x($page,'aside')) echo $page['aside']; ?>\r
-- <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>\r
--<!-- </div>-->\r
-- </div>\r
-- <?php } ?>\r
-- <?php if(x($page,'end')) echo $page['end']; ?>\r
--</body>\r
--</html>\r
++<!DOCTYPE html >
++<html lang="<?php echo $lang; ?>">
++<head>
++ <title><?php if(x($page,'title')) echo $page['title'] ?></title>
++ <script>var baseurl="<?php echo Friendica\App::get_baseurl() ?>";</script>
++ <?php if(x($page,'htmlhead')) echo $page['htmlhead'] ?>
++</head>
++<body <?php if($a->module === 'home') echo 'onLoad="setTimeout(\'homeRedirect()\', 1500)"'?>>
++ <?php if(x($page,'nav')) echo $page['nav']; ?>
++
++ <?php if( $a->module === 'home' ) { ?>
++ <center>
++ <div class="login-button">
++ <a href="login" class="login-button-link"><img class="login-button-image" src="images/friendica-1600.png" title="Click to log in"></a>
++ </div>
++ </center>
++
++ <?php } elseif ( $a->module === 'login' || $a->module === 'register' || $a->module === 'lostpass' ) {
++ ?>
++ <div class='section-wrapper'>
++ <section><?php if(x($page,'content')) echo $page['content']; ?>
++ </section>
++ </div>
++ <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>
++
++ <?php } else { ?>
++ <div class='main-container'>
++<!-- <div class='main-content-container'>-->
++ <div class='section-wrapper'>
++ <?php if( ($a->module === 'settings' || $a->module === 'message' || $a->module === 'profile') && x($page,'aside')) echo $page['aside']; ?>
++ <section>
++ <?php if(x($page,'content')) echo $page['content']; ?>
++ <div id="pause"></div> <!-- The pause/resume Ajax indicator -->
++ <div id="page-footer"></div>
++ </section>
++ </div>
++ <right_aside><?php if(x($page,'right_aside')) echo $page['right_aside']; ?></right_aside>
++ <?php if( ($a->module === 'contacts') && x($page,'aside')) echo $page['aside']; ?>
++ <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>
++<!-- </div>-->
++ </div>
++ <?php } ?>
++ <?php if(x($page,'end')) echo $page['end']; ?>
++</body>
++</html>
--<!DOCTYPE html >\r
--<html lang="<?php echo $lang; ?>">\r
--<head>\r
-- <title><?php if(x($page,'title')) echo $page['title'] ?></title>\r
- <script>var baseurl="<?php echo App::get_baseurl() ?>";</script>\r
- <script>var baseurl="<?php echo Friendica\App::get_baseurl() ?>";</script>\r
-- <?php if(x($page,'htmlhead')) echo $page['htmlhead'] ?>\r
--</head>\r
--<body <?php if($a->module === 'home') echo 'onLoad="setTimeout(\'homeRedirect()\', 1500)"'?>>\r
-- <?php if(x($page,'nav')) echo $page['nav']; ?>\r
--\r
-- <?php if( $a->module === 'home' ) { ?>\r
-- <center>\r
-- <div class="login-button">\r
-- <a href="login" class="login-button-link"><img class="login-button-image" src="/images/friendica-1600.png" title="Click to log in"></a>\r
-- </div>\r
-- </center>\r
--\r
-- <?php } elseif ( $a->module === 'login' || $a->module === 'register' || $a->module === 'lostpass' ) {\r
-- ?>\r
-- <div class='section-wrapper'>\r
-- <section><?php if(x($page,'content')) echo $page['content']; ?>\r
-- </section>\r
-- </div>\r
-- <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>\r
--\r
-- <?php } else { ?>\r
-- <div class='main-container'>\r
-- <!--<div class='main-content-loading'><img src="/view/theme/frost/images/ajax-loader.gif" alt="Please wait..."></div>-->\r
-- <div class='main-content-container'>\r
-- <aside><?php if(x($page,'aside')) echo $page['aside']; ?></aside>\r
-- <section>\r
-- <?php if(x($page,'content')) echo $page['content']; ?>\r
-- <div id="pause"></div> <!-- The pause/resume Ajax indicator -->\r
-- <div id="page-footer"></div>\r
-- </section>\r
-- <right_aside><?php if(x($page,'right_aside')) echo $page['right_aside']; ?></right_aside>\r
-- <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>\r
-- </div>\r
-- </div>\r
-- <?php } ?>\r
-- <?php if(x($page,'end')) echo $page['end']; ?>\r
--</body>\r
--</html>\r
++<!DOCTYPE html >
++<html lang="<?php echo $lang; ?>">
++<head>
++ <title><?php if(x($page,'title')) echo $page['title'] ?></title>
++ <script>var baseurl="<?php echo Friendica\App::get_baseurl() ?>";</script>
++ <?php if(x($page,'htmlhead')) echo $page['htmlhead'] ?>
++</head>
++<body <?php if($a->module === 'home') echo 'onLoad="setTimeout(\'homeRedirect()\', 1500)"'?>>
++ <?php if(x($page,'nav')) echo $page['nav']; ?>
++
++ <?php if( $a->module === 'home' ) { ?>
++ <center>
++ <div class="login-button">
++ <a href="login" class="login-button-link"><img class="login-button-image" src="/images/friendica-1600.png" title="Click to log in"></a>
++ </div>
++ </center>
++
++ <?php } elseif ( $a->module === 'login' || $a->module === 'register' || $a->module === 'lostpass' ) {
++ ?>
++ <div class='section-wrapper'>
++ <section><?php if(x($page,'content')) echo $page['content']; ?>
++ </section>
++ </div>
++ <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>
++
++ <?php } else { ?>
++ <div class='main-container'>
++ <!--<div class='main-content-loading'><img src="/view/theme/frost/images/ajax-loader.gif" alt="Please wait..."></div>-->
++ <div class='main-content-container'>
++ <aside><?php if(x($page,'aside')) echo $page['aside']; ?></aside>
++ <section>
++ <?php if(x($page,'content')) echo $page['content']; ?>
++ <div id="pause"></div> <!-- The pause/resume Ajax indicator -->
++ <div id="page-footer"></div>
++ </section>
++ <right_aside><?php if(x($page,'right_aside')) echo $page['right_aside']; ?></right_aside>
++ <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>
++ </div>
++ </div>
++ <?php } ?>
++ <?php if(x($page,'end')) echo $page['end']; ?>
++</body>
++</html>
projects / friendica.git / commitdiff