Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2025-05-09 19:44:10 +02:00
Code Issues Projects Releases Packages Wiki Activity

@brief is removed completely

Browse source
This commit is contained in:
Michael 2020-01-19 06:05:23 +00:00
parent fd1f1999f0
commit 0a4119adaf
170 changed files with 901 additions and 962 deletions
Download patch file Download diff file Expand all files Collapse all files

166
src/Protocol/Diaspora.php
View file

@ -1,7 +1,7 @@
<?php
/**
* @file src/Protocol/diaspora.php
* @brief The implementation of the diaspora protocol
* The implementation of the diaspora protocol
*
* The new protocol is described here: http://diaspora.github.io/diaspora_federation/index.html
* This implementation here interprets the old and the new protocol and sends the new one.
@ -41,7 +41,7 @@ use Friendica\Worker\Delivery;
use SimpleXMLElement;
/**
* @brief This class contain functions to create and send Diaspora XML files
* This class contain functions to create and send Diaspora XML files
*
*/
class Diaspora
@ -77,7 +77,7 @@ class Diaspora
}
/**
* @brief Return a list of relay servers
* Return a list of relay servers
*
* The list contains not only the official relays but also servers that we serve directly
*
@ -167,7 +167,7 @@ class Diaspora
}
/**
* @brief Return a contact for a given server address or creates a dummy entry
* Return a contact for a given server address or creates a dummy entry
*
* @param string $server_url The url of the server
* @param array $fields Fieldlist
@ -200,7 +200,7 @@ class Diaspora
}
/**
* @brief Update or insert a relay contact
* Update or insert a relay contact
*
* @param string $server_url The url of the server
* @param array $network_fields Optional network specific fields
@ -234,7 +234,7 @@ class Diaspora
}
/**
* @brief Return a list of participating contacts for a thread
* Return a list of participating contacts for a thread
*
* This is used for the participation feature.
* One of the parameters is a contact array.
@ -286,7 +286,7 @@ class Diaspora
}
/**
* @brief repairs a signature that was double encoded
* repairs a signature that was double encoded
*
* The function is unused at the moment. It was copied from the old implementation.
*
@ -317,7 +317,7 @@ class Diaspora
}
/**
* @brief verify the envelope and return the verified data
* verify the envelope and return the verified data
*
* @param string $envelope The magic envelope
*
@ -382,7 +382,7 @@ class Diaspora
}
/**
* @brief encrypts data via AES
* encrypts data via AES
*
* @param string $key The AES key
* @param string $iv The IV (is used for CBC encoding)
@ -396,7 +396,7 @@ class Diaspora
}
/**
* @brief decrypts data via AES
* decrypts data via AES
*
* @param string $key The AES key
* @param string $iv The IV (is used for CBC encoding)
@ -659,7 +659,7 @@ class Diaspora
/**
* @brief Dispatches public messages and find the fitting receivers
* Dispatches public messages and find the fitting receivers
*
* @param array $msg The post that will be dispatched
*
@ -687,7 +687,7 @@ class Diaspora
}
/**
* @brief Dispatches the different message types to the different functions
* Dispatches the different message types to the different functions
*
* @param array $importer Array of the importer user
* @param array $msg The post that will be dispatched
@ -792,7 +792,7 @@ class Diaspora
}
/**
* @brief Checks if a posting is valid and fetches the data fields.
* Checks if a posting is valid and fetches the data fields.
*
* This function does not only check the signature.
* It also does the conversion between the old and the new diaspora format.
@ -945,7 +945,7 @@ class Diaspora
}
/**
* @brief Fetches the public key for a given handle
* Fetches the public key for a given handle
*
* @param string $handle The handle
*
@ -968,7 +968,7 @@ class Diaspora
}
/**
* @brief Fetches data for a given handle
* Fetches data for a given handle
*
* @param string $handle The handle
* @param boolean $update true = always update, false = never update, null = update when not found or outdated
@ -1022,7 +1022,7 @@ class Diaspora
}
/**
* @brief Updates the fcontact table
* Updates the fcontact table
*
* @param array $arr The fcontact data
* @throws \Exception
@ -1043,7 +1043,7 @@ class Diaspora
}
/**
* @brief get a handle (user@domain.tld) from a given contact id
* get a handle (user@domain.tld) from a given contact id
*
* @param int $contact_id The id in the contact table
* @param int $pcontact_id The id in the contact table (Used for the public contact)
@ -1090,7 +1090,7 @@ class Diaspora
}
/**
* @brief get a url (scheme://domain.tld/u/user) from a given Diaspora*
* get a url (scheme://domain.tld/u/user) from a given Diaspora*
* fcontact guid
*
* @param mixed $fcontact_guid Hexadecimal string guid
@ -1116,7 +1116,7 @@ class Diaspora
}
/**
* @brief Get a contact id for a given handle
* Get a contact id for a given handle
*
* @todo Move to Friendica\Model\Contact
*
@ -1160,7 +1160,7 @@ class Diaspora
}
/**
* @brief Check if posting is allowed for this contact
* Check if posting is allowed for this contact
*
* @param array $importer Array of the importer user
* @param array $contact The contact that is checked
@ -1213,7 +1213,7 @@ class Diaspora
}
/**
* @brief Fetches the contact id for a handle and checks if posting is allowed
* Fetches the contact id for a handle and checks if posting is allowed
*
* @param array $importer Array of the importer user
* @param string $handle The checked handle in the format user@domain.tld
@ -1245,7 +1245,7 @@ class Diaspora
}
/**
* @brief Does the message already exists on the system?
* Does the message already exists on the system?
*
* @param int $uid The user id
* @param string $guid The guid of the message
@ -1265,7 +1265,7 @@ class Diaspora
}
/**
* @brief Checks for links to posts in a message
* Checks for links to posts in a message
*
* @param array $item The item array
* @return void
@ -1291,7 +1291,7 @@ class Diaspora
}
/**
* @brief Checks for relative /people/* links in an item body to match local
* Checks for relative /people/* links in an item body to match local
* contacts or prepends the remote host taken from the author link.
*
* @param string $body The item body to replace links from
@ -1327,7 +1327,7 @@ class Diaspora
}
/**
* @brief sub function of "fetchGuid" which checks for links in messages
* sub function of "fetchGuid" which checks for links in messages
*
* @param array $match array containing a link that has to be checked for a message link
* @param array $item The item array
@ -1343,7 +1343,7 @@ class Diaspora
}
/**
* @brief Fetches an item with a given guid from a given server
* Fetches an item with a given guid from a given server
*
* @param string $guid the message guid
* @param string $server The server address
@ -1378,7 +1378,7 @@ class Diaspora
}
/**
* @brief Fetches a message from a server
* Fetches a message from a server
*
* @param string $guid message guid
* @param string $server The url of the server
@ -1457,7 +1457,7 @@ class Diaspora
}
/**
* @brief Fetches an item with a given URL
* Fetches an item with a given URL
*
* @param string $url the message url
*
@ -1490,7 +1490,7 @@ class Diaspora
}
/**
* @brief Fetches the item record of a given guid
* Fetches the item record of a given guid
*
* @param int $uid The user id
* @param string $guid message guid
@ -1534,7 +1534,7 @@ class Diaspora
}
/**
* @brief returns contact details
* returns contact details
*
* @param array $def_contact The default contact if the person isn't found
* @param array $person The record of the person
@ -1561,7 +1561,7 @@ class Diaspora
}
/**
* @brief Is the profile a hubzilla profile?
* Is the profile a hubzilla profile?
*
* @param string $url The profile link
*
@ -1573,7 +1573,7 @@ class Diaspora
}
/**
* @brief Generate a post link with a given handle and message guid
* Generate a post link with a given handle and message guid
*
* @param string $addr The user handle
* @param string $guid message guid
@ -1612,7 +1612,7 @@ class Diaspora
}
/**
* @brief Receives account migration
* Receives account migration
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -1675,7 +1675,7 @@ class Diaspora
}
/**
* @brief Processes an account deletion
* Processes an account deletion
*
* @param object $data The message object
*
@ -1699,7 +1699,7 @@ class Diaspora
}
/**
* @brief Fetch the uri from our database if we already have this item (maybe from ourselves)
* Fetch the uri from our database if we already have this item (maybe from ourselves)
*
* @param string $author Author handle
* @param string $guid Message guid
@ -1728,7 +1728,7 @@ class Diaspora
}
/**
* @brief Fetch the guid from our database with a given uri
* Fetch the guid from our database with a given uri
*
* @param string $uri Message uri
* @param string $uid Author handle
@ -1747,7 +1747,7 @@ class Diaspora
}
/**
* @brief Find the best importer for a comment, like, ...
* Find the best importer for a comment, like, ...
*
* @param string $guid The guid of the item
*
@ -1768,7 +1768,7 @@ class Diaspora
}
/**
* @brief Processes an incoming comment
* Processes an incoming comment
*
* @param array $importer Array of the importer user
* @param string $sender The sender of the message
@ -1885,7 +1885,7 @@ class Diaspora
}
/**
* @brief processes and stores private messages
* processes and stores private messages
*
* @param array $importer Array of the importer user
* @param array $contact The contact of the message
@ -1945,7 +1945,7 @@ class Diaspora
}
/**
* @brief Processes new private messages (answers to private messages are processed elsewhere)
* Processes new private messages (answers to private messages are processed elsewhere)
*
* @param array $importer Array of the importer user
* @param array $msg Array of the processed message, author handle and key
@ -2004,7 +2004,7 @@ class Diaspora
}
/**
* @brief Processes "like" messages
* Processes "like" messages
*
* @param array $importer Array of the importer user
* @param string $sender The sender of the message
@ -2116,7 +2116,7 @@ class Diaspora
}
/**
* @brief Processes private messages
* Processes private messages
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2177,7 +2177,7 @@ class Diaspora
}
/**
* @brief Processes participations - unsupported by now
* Processes participations - unsupported by now
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2241,7 +2241,7 @@ class Diaspora
}
/**
* @brief Processes photos - unneeded
* Processes photos - unneeded
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2256,7 +2256,7 @@ class Diaspora
}
/**
* @brief Processes poll participations - unssupported
* Processes poll participations - unssupported
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2270,7 +2270,7 @@ class Diaspora
}
/**
* @brief Processes incoming profile updates
* Processes incoming profile updates
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2368,7 +2368,7 @@ class Diaspora
}
/**
* @brief Processes incoming friend requests
* Processes incoming friend requests
*
* @param array $importer Array of the importer user
* @param array $contact The contact that send the request
@ -2387,7 +2387,7 @@ class Diaspora
}
/**
* @brief Processes incoming sharing notification
* Processes incoming sharing notification
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2499,7 +2499,7 @@ class Diaspora
}
/**
* @brief Fetches a message with a given guid
* Fetches a message with a given guid
*
* @param string $guid message guid
* @param string $orig_author handle of the original post
@ -2579,7 +2579,7 @@ class Diaspora
}
/**
* @brief Stores a reshare activity
* Stores a reshare activity
*
* @param array $item Array of reshare post
* @param integer $parent_message_id Id of the parent post
@ -2627,7 +2627,7 @@ class Diaspora
}
/**
* @brief Processes a reshare message
* Processes a reshare message
*
* @param array $importer Array of the importer user
* @param object $data The message object
@ -2732,7 +2732,7 @@ class Diaspora
}
/**
* @brief Processes retractions
* Processes retractions
*
* @param array $importer Array of the importer user
* @param array $contact The contact of the item owner
@ -2797,7 +2797,7 @@ class Diaspora
}
/**
* @brief Receives retraction messages
* Receives retraction messages
*
* @param array $importer Array of the importer user
* @param string $sender The sender of the message
@ -2843,7 +2843,7 @@ class Diaspora
}
/**
* @brief Receives status messages
* Receives status messages
*
* @param array $importer Array of the importer user
* @param SimpleXMLElement $data The message object
@ -2967,7 +2967,7 @@ class Diaspora
* ************************************************************************************** */
/**
* @brief returnes the handle of a contact
* returnes the handle of a contact
*
* @param array $contact contact array
*
@ -2993,7 +2993,7 @@ class Diaspora
/**
* @brief Creates the data for a private message in the new format
* Creates the data for a private message in the new format
*
* @param string $msg The message that is to be transmitted
* @param array $user The record of the sender
@ -3035,7 +3035,7 @@ class Diaspora
}
/**
* @brief Creates the envelope for the "fetch" endpoint and for the new format
* Creates the envelope for the "fetch" endpoint and for the new format
*
* @param string $msg The message that is to be transmitted
* @param array $user The record of the sender
@ -3075,7 +3075,7 @@ class Diaspora
}
/**
* @brief Create the envelope for a message
* Create the envelope for a message
*
* @param string $msg The message that is to be transmitted
* @param array $user The record of the sender
@ -3101,7 +3101,7 @@ class Diaspora
}
/**
* @brief Creates a signature for a message
* Creates a signature for a message
*
* @param array $owner the array of the owner of the message
* @param array $message The message that is to be signed
@ -3120,7 +3120,7 @@ class Diaspora
}
/**
* @brief Transmit a message to a target server
* Transmit a message to a target server
*
* @param array $owner the array of the item owner
* @param array $contact Target of the communication
@ -3178,7 +3178,7 @@ class Diaspora
/**
* @brief Build the post xml
* Build the post xml
*
* @param string $type The message type
* @param array $message The message data
@ -3193,7 +3193,7 @@ class Diaspora
}
/**
* @brief Builds and transmit messages
* Builds and transmit messages
*
* @param array $owner the array of the item owner
* @param array $contact Target of the communication
@ -3228,7 +3228,7 @@ class Diaspora
}
/**
* @brief sends a participation (Used to get all further updates)
* sends a participation (Used to get all further updates)
*
* @param array $contact Target of the communication
* @param array $item Item array
@ -3277,7 +3277,7 @@ class Diaspora
}
/**
* @brief sends an account migration
* sends an account migration
*
* @param array $owner the array of the item owner
* @param array $contact Target of the communication
@ -3305,7 +3305,7 @@ class Diaspora
}
/**
* @brief Sends a "share" message
* Sends a "share" message
*
* @param array $owner the array of the item owner
* @param array $contact Target of the communication
@ -3349,7 +3349,7 @@ class Diaspora
}
/**
* @brief sends an "unshare"
* sends an "unshare"
*
* @param array $owner the array of the item owner
* @param array $contact Target of the communication
@ -3370,7 +3370,7 @@ class Diaspora
}
/**
* @brief Checks a message body if it is a reshare
* Checks a message body if it is a reshare
*
* @param string $body The message body that is to be check
* @param bool $complete Should it be a complete check or a simple check?
@ -3428,7 +3428,7 @@ class Diaspora
}
/**
* @brief Create an event array
* Create an event array
*
* @param integer $event_id The id of the event
*
@ -3508,7 +3508,7 @@ class Diaspora
}
/**
* @brief Create a post (status message or reshare)
* Create a post (status message or reshare)
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3647,7 +3647,7 @@ class Diaspora
}
/**
* @brief Sends a post
* Sends a post
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3666,7 +3666,7 @@ class Diaspora
}
/**
* @brief Creates a "like" object
* Creates a "like" object
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3698,7 +3698,7 @@ class Diaspora
}
/**
* @brief Creates an "EventParticipation" object
* Creates an "EventParticipation" object
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3736,7 +3736,7 @@ class Diaspora
}
/**
* @brief Creates the object for a comment
* Creates the object for a comment
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3803,7 +3803,7 @@ class Diaspora
}
/**
* @brief Send a like or a comment
* Send a like or a comment
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3837,7 +3837,7 @@ class Diaspora
}
/**
* @brief Creates a message from a signature record entry
* Creates a message from a signature record entry
*
* @param array $item The item that will be exported
* @return array The message
@ -3882,7 +3882,7 @@ class Diaspora
}
/**
* @brief Relays messages (like, comment, retraction) to other servers if we are the thread owner
* Relays messages (like, comment, retraction) to other servers if we are the thread owner
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3938,7 +3938,7 @@ class Diaspora
}
/**
* @brief Sends a retraction (deletion) of a message, like or comment
* Sends a retraction (deletion) of a message, like or comment
*
* @param array $item The item that will be exported
* @param array $owner the array of the item owner
@ -3973,7 +3973,7 @@ class Diaspora
}
/**
* @brief Sends a mail
* Sends a mail
*
* @param array $item The item that will be exported
* @param array $owner The owner
@ -4024,7 +4024,7 @@ class Diaspora
}
/**
* @brief Split a name into first name and last name
* Split a name into first name and last name
*
* @param string $name The name
*
@ -4080,7 +4080,7 @@ class Diaspora
}
/**
* @brief Create profile data
* Create profile data
*
* @param int $uid The user id
*
@ -4165,7 +4165,7 @@ class Diaspora
}
/**
* @brief Sends profile data
* Sends profile data
*
* @param int $uid The user id
* @param bool $recips optional, default false
@ -4207,7 +4207,7 @@ class Diaspora
}
/**
* @brief Creates the signature for likes that are created on our system
* Creates the signature for likes that are created on our system
*
* @param integer $uid The user of that comment
* @param array $item Item array
@ -4238,7 +4238,7 @@ class Diaspora
}
/**
* @brief Creates the signature for Comments that are created on our system
* Creates the signature for Comments that are created on our system
*
* @param integer $uid The user of that comment
* @param array $item Item array