Merge pull request #8163 from MrPetovan/task/7817-custom-fields-part-3

New custom profile fields feature part 3: Updating the API

src/Module/Admin/Addons/Details.php

@@ -6,10 +6,10 @@ use Friendica\Content\Text\Markdown;
 use Friendica\Core\Addon;
 use Friendica\Core\Renderer;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Util\Strings;
 
-class Details extends BaseAdminModule
+class Details extends BaseAdmin
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Admin/Addons/Index.php

@@ -5,9 +5,9 @@ namespace Friendica\Module\Admin\Addons;
 use Friendica\Core\Addon;
 use Friendica\Core\Renderer;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 
-class Index extends BaseAdminModule
+class Index extends BaseAdmin
 {
 	public static function content(array $parameters = [])
 	{

src/Module/Admin/Blocklist/Contact.php

@@ -6,10 +6,10 @@ use Friendica\Content\Pager;
 use Friendica\Core\Renderer;
 use Friendica\Database\DBA;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Model;
 
-class Contact extends BaseAdminModule
+class Contact extends BaseAdmin
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Admin/Blocklist/Server.php

@@ -4,10 +4,10 @@ namespace Friendica\Module\Admin\Blocklist;
 
 use Friendica\Core\Renderer;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Util\Strings;
 
-class Server extends BaseAdminModule
+class Server extends BaseAdmin
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Admin/DBSync.php

@@ -7,9 +7,9 @@ use Friendica\Core\Update;
 use Friendica\Database\DBA;
 use Friendica\Database\DBStructure;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 
-class DBSync extends BaseAdminModule
+class DBSync extends BaseAdmin
 {
 	public static function content(array $parameters = [])
 	{

src/Module/Admin/Features.php

@@ -5,9 +5,9 @@ namespace Friendica\Module\Admin;
 use Friendica\Content\Feature;
 use Friendica\Core\Renderer;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 
-class Features extends BaseAdminModule
+class Features extends BaseAdmin
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Admin/Federation.php

@@ -5,9 +5,9 @@ namespace Friendica\Module\Admin;
 use Friendica\Core\Renderer;
 use Friendica\Database\DBA;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 
-class Federation extends BaseAdminModule
+class Federation extends BaseAdmin
 {
 	public static function content(array $parameters = [])
 	{

src/Module/Admin/Item/Delete.php

@@ -5,10 +5,10 @@ namespace Friendica\Module\Admin\Item;
 use Friendica\Core\Renderer;
 use Friendica\DI;
 use Friendica\Model\Item;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Util\Strings;
 
-class Delete extends BaseAdminModule
+class Delete extends BaseAdmin
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Admin/Item/Source.php

@@ -5,12 +5,12 @@ namespace Friendica\Module\Admin\Item;
 use Friendica\Core\Renderer;
 use Friendica\DI;
 use Friendica\Model;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 
 /**
  * @author Hypolite Petovan <mrpetovan@gmail.com>
  */
-class Source extends BaseAdminModule
+class Source extends BaseAdmin
 
 {
 	public static function content(array $parameters = [])

src/Module/Admin/Logs/Settings.php

@@ -4,11 +4,11 @@ namespace Friendica\Module\Admin\Logs;
 
 use Friendica\Core\Renderer;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Util\Strings;
 use Psr\Log\LogLevel;
 
-class Settings extends BaseAdminModule
+class Settings extends BaseAdmin
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Admin/Logs/View.php

@@ -4,10 +4,10 @@ namespace Friendica\Module\Admin\Logs;
 
 use Friendica\Core\Renderer;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Util\Strings;
 
-class View extends BaseAdminModule
+class View extends BaseAdmin
 {
 	public static function content(array $parameters = [])
 	{

src/Module/Admin/PhpInfo.php

@@ -2,9 +2,9 @@
 
 namespace Friendica\Module\Admin;
 
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 
-class PhpInfo extends BaseAdminModule
+class PhpInfo extends BaseAdmin
 {
 	public static function rawContent(array $parameters = [])
 	{

src/Module/Admin/Queue.php

@@ -5,7 +5,7 @@ namespace Friendica\Module\Admin;
 use Friendica\Core\Renderer;
 use Friendica\Database\DBA;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Util\Arrays;
 use Friendica\Util\DateTimeFormat;
 
@@ -17,7 +17,7 @@ use Friendica\Util\DateTimeFormat;
  *
  * @return string
  */
-class Queue extends BaseAdminModule
+class Queue extends BaseAdmin
 {
 	public static function content(array $parameters = [])
 	{

src/Module/Admin/Site.php

@@ -9,7 +9,7 @@ use Friendica\Core\Theme;
 use Friendica\Core\Worker;
 use Friendica\Database\DBA;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Module\Register;
 use Friendica\Protocol\PortableContact;
 use Friendica\Util\BasePath;
@@ -18,7 +18,7 @@ use Friendica\Worker\Delivery;
 
 require_once __DIR__ . '/../../../boot.php';
 
-class Site extends BaseAdminModule
+class Site extends BaseAdmin
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Admin/Summary.php

@@ -11,13 +11,13 @@ use Friendica\Database\DBA;
 use Friendica\Database\DBStructure;
 use Friendica\DI;
 use Friendica\Model\Register;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Network\HTTPException\InternalServerErrorException;
 use Friendica\Util\ConfigFileLoader;
 use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Network;
 
-class Summary extends BaseAdminModule
+class Summary extends BaseAdmin
 {
 	public static function content(array $parameters = [])
 	{

src/Module/Admin/Themes/Details.php

@@ -6,10 +6,10 @@ use Friendica\Content\Text\Markdown;
 use Friendica\Core\Renderer;
 use Friendica\Core\Theme;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Util\Strings;
 
-class Details extends BaseAdminModule
+class Details extends BaseAdmin
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Admin/Themes/Embed.php

@@ -4,10 +4,10 @@ namespace Friendica\Module\Admin\Themes;
 
 use Friendica\Core\Renderer;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Util\Strings;
 
-class Embed extends BaseAdminModule
+class Embed extends BaseAdmin
 {
 	public static function init(array $parameters = [])
 	{

src/Module/Admin/Themes/Index.php

@@ -5,10 +5,10 @@ namespace Friendica\Module\Admin\Themes;
 use Friendica\Core\Renderer;
 use Friendica\Core\Theme;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Util\Strings;
 
-class Index extends BaseAdminModule
+class Index extends BaseAdmin
 {
 	public static function content(array $parameters = [])
 	{

src/Module/Admin/Tos.php

@@ -4,9 +4,9 @@ namespace Friendica\Module\Admin;
 
 use Friendica\Core\Renderer;
 use Friendica\DI;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 
-class Tos extends BaseAdminModule
+class Tos extends BaseAdmin
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Admin/Users.php

@@ -8,11 +8,11 @@ use Friendica\Database\DBA;
 use Friendica\DI;
 use Friendica\Model\Register;
 use Friendica\Model\User;
-use Friendica\Module\BaseAdminModule;
+use Friendica\Module\BaseAdmin;
 use Friendica\Util\Strings;
 use Friendica\Util\Temporal;
 
-class Users extends BaseAdminModule
+class Users extends BaseAdmin
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Api/Friendica/Profile/Show.php

@@ -0,0 +1,114 @@
+<?php
+
+namespace Friendica\Module\Api\Friendica\Profile;
+
+use Friendica\Collection\ProfileFields;
+use Friendica\Content\Text\BBCode;
+use Friendica\DI;
+use Friendica\Model\Contact;
+use Friendica\Model\Profile;
+use Friendica\Module\BaseApi;
+use Friendica\Network\HTTPException;
+use Friendica\Repository\PermissionSet;
+
+/**
+ * API endpoint: /api/friendica/profile/show
+ */
+class Show extends BaseApi
+{
+	public static function rawContent(array $parameters = [])
+	{
+		if (self::login() === false) {
+			throw new HTTPException\ForbiddenException();
+		}
+
+		// retrieve general information about profiles for user
+		$directory = DI::config()->get('system', 'directory');
+
+		$profile = Profile::getByUID(self::$current_user_id);
+		
+		$profileFields = DI::profileField()->select(['uid' => self::$current_user_id, 'psid' => PermissionSet::PUBLIC]);
+
+		$profile = self::formatProfile($profile, $profileFields);
+
+		$profiles = [];
+		if (self::$format == 'xml') {
+			$profiles['0:profile'] = $profile;
+		} else {
+			$profiles[] = $profile;
+		}
+
+		// return settings, authenticated user and profiles data
+		$self = Contact::selectFirst(['nurl'], ['uid' => self::$current_user_id, 'self' => true]);
+
+		$result = [
+			'multi_profiles' => false,
+			'global_dir' => $directory,
+			'friendica_owner' => self::getUser($self['nurl']),
+			'profiles' => $profiles
+		];
+
+		echo self::format('friendica_profiles', ['$result' => $result]);
+		exit;
+	}
+
+	/**
+	 * @param array         $profile_row array containing data from db table 'profile'
+	 * @param ProfileFields $profileFields
+	 * @return array
+	 * @throws HTTPException\InternalServerErrorException
+	 */
+	private static function formatProfile($profile_row, ProfileFields $profileFields)
+	{
+		$custom_fields = [];
+		foreach ($profileFields as $profileField) {
+			$custom_fields[] = [
+				'label' => $profileField->label,
+				'value' => BBCode::convert($profileField->value, false, 2),
+			];
+		}
+
+		return [
+			'profile_id'       => $profile_row['id'],
+			'profile_name'     => null,
+			'is_default'       => null,
+			'hide_friends'     => $profile_row['hide-friends'] ? true : false,
+			'profile_photo'    => $profile_row['photo'],
+			'profile_thumb'    => $profile_row['thumb'],
+			'publish'          => $profile_row['publish'] ? true : false,
+			'net_publish'      => $profile_row['net-publish'] ? true : false,
+			'description'      => $profile_row['pdesc'],
+			'date_of_birth'    => $profile_row['dob'],
+			'address'          => $profile_row['address'],
+			'city'             => $profile_row['locality'],
+			'region'           => $profile_row['region'],
+			'postal_code'      => $profile_row['postal-code'],
+			'country'          => $profile_row['country-name'],
+			'hometown'         => null,
+			'gender'           => null,
+			'marital'          => null,
+			'marital_with'     => null,
+			'marital_since'    => null,
+			'sexual'           => null,
+			'politic'          => null,
+			'religion'         => null,
+			'public_keywords'  => $profile_row['pub_keywords'],
+			'private_keywords' => $profile_row['prv_keywords'],
+			'likes'            => null,
+			'dislikes'         => null,
+			'about'            => null,
+			'music'            => null,
+			'book'             => null,
+			'tv'               => null,
+			'film'             => null,
+			'interest'         => null,
+			'romance'          => null,
+			'work'             => null,
+			'education'        => null,
+			'social_networks'  => null,
+			'homepage'         => $profile_row['homepage'],
+			'users'            => [],
+			'custom_fields'    => $custom_fields,
+		];
+	}
+}

src/Module/BaseAdmin.php

@@ -21,7 +21,7 @@ require_once 'boot.php';
  *
  * @package Friendica\Module
  */
-abstract class BaseAdminModule extends BaseModule
+abstract class BaseAdmin extends BaseModule
 {
 	public static function post(array $parameters = [])
 	{

src/Module/BaseApi.php

@@ -87,20 +87,53 @@ class BaseApi extends BaseModule
 		return api_get_user(DI::app(), $contact_id);
 	}
 
-	protected static function format($root_element, $data)
+	/**
+	 * Formats the data according to the data type
+	 *
+	 * @param string $root_element
+	 * @param array $data An array with a single element containing the returned result
+	 * @return false|string
+	 */
+	protected static function format(string $root_element, array $data)
 	{
+		$return = api_format_data($root_element, self::$format, $data);
+
 		switch (self::$format) {
-			case "atom":
-			case "rss":
 			case "xml":
-				$ret = api_create_xml($data, $root_element);
+				header("Content-Type: text/xml");
 				break;
 			case "json":
-			default:
-				$ret = $data;
+				header("Content-Type: application/json");
+				if (!empty($return)) {
+					$json = json_encode(end($return));
+					if (!empty($_GET['callback'])) {
+						$json = $_GET['callback'] . "(" . $json . ")";
+					}
+					$return = $json;
+				}
+				break;
+			case "rss":
+				header("Content-Type: application/rss+xml");
+				$return  = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
+				break;
+			case "atom":
+				header("Content-Type: application/atom+xml");
+				$return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
 				break;
 		}
+		
+		return $return;
+	}
 
-		return $ret;
+	/**
+	 * Creates the XML from a JSON style array
+	 *
+	 * @param $data
+	 * @param $root_element
+	 * @return string
+	 */
+	protected static function createXml($data, $root_element)
+	{
+		return api_create_xml($data, $root_element);
 	}
 }

src/Module/BaseSearch.php

@@ -17,7 +17,7 @@ use Friendica\Util\Proxy as ProxyUtils;
 /**
  * Base class for search modules
  */
-class BaseSearchModule extends BaseModule
+class BaseSearch extends BaseModule
 {
 	/**
 	 * Performs a contact search with an optional prefix

src/Module/BaseSettings.php

@@ -7,7 +7,7 @@ use Friendica\Content\Feature;
 use Friendica\Core\Renderer;
 use Friendica\DI;
 
-class BaseSettingsModule extends BaseModule
+class BaseSettings extends BaseModule
 {
 	public static function content(array $parameters = [])
 	{

src/Module/Search/Directory.php

@@ -4,14 +4,14 @@ namespace Friendica\Module\Search;
 
 use Friendica\Content\Widget;
 use Friendica\DI;
-use Friendica\Module\BaseSearchModule;
+use Friendica\Module\BaseSearch;
 use Friendica\Module\Security\Login;
 use Friendica\Util\Strings;
 
 /**
  * Directory search module
  */
-class Directory extends BaseSearchModule
+class Directory extends BaseSearch
 {
 	public static function content(array $parameters = [])
 	{

src/Module/Search/Index.php

@@ -15,11 +15,11 @@ use Friendica\DI;
 use Friendica\Model\Contact;
 use Friendica\Model\Item;
 use Friendica\Model\Term;
-use Friendica\Module\BaseSearchModule;
+use Friendica\Module\BaseSearch;
 use Friendica\Network\HTTPException;
 use Friendica\Util\Strings;
 
-class Index extends BaseSearchModule
+class Index extends BaseSearch
 {
 	public static function content(array $parameters = [])
 	{

src/Module/Settings/Delegation.php

@@ -8,14 +8,14 @@ use Friendica\Core\Session;
 use Friendica\Database\DBA;
 use Friendica\DI;
 use Friendica\Model\User;
-use Friendica\Module\BaseSettingsModule;
+use Friendica\Module\BaseSettings;
 use Friendica\Network\HTTPException;
 use Friendica\Util\Strings;
 
 /**
  * Account delegation settings module
  */
-class Delegation extends BaseSettingsModule
+class Delegation extends BaseSettings
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Settings/Profile/Index.php

@@ -16,14 +16,14 @@ use Friendica\Model\GContact;
 use Friendica\Model\Profile;
 use Friendica\Model\ProfileField;
 use Friendica\Model\User;
-use Friendica\Module\BaseSettingsModule;
+use Friendica\Module\BaseSettings;
 use Friendica\Module\Security\Login;
 use Friendica\Network\HTTPException;
 use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Strings;
 use Friendica\Util\Temporal;
 
-class Index extends BaseSettingsModule
+class Index extends BaseSettings
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Settings/Profile/Photo/Crop.php

@@ -9,10 +9,10 @@ use Friendica\Database\DBA;
 use Friendica\DI;
 use Friendica\Model\Contact;
 use Friendica\Model\Photo;
-use Friendica\Module\BaseSettingsModule;
+use Friendica\Module\BaseSettings;
 use Friendica\Network\HTTPException;
 
-class Crop extends BaseSettingsModule
+class Crop extends BaseSettings
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Settings/Profile/Photo/Index.php

@@ -8,13 +8,13 @@ use Friendica\Core\Session;
 use Friendica\DI;
 use Friendica\Model\Contact;
 use Friendica\Model\Photo;
-use Friendica\Module\BaseSettingsModule;
+use Friendica\Module\BaseSettings;
 use Friendica\Network\HTTPException;
 use Friendica\Object\Image;
 use Friendica\Util\Images;
 use Friendica\Util\Strings;
 
-class Index extends BaseSettingsModule
+class Index extends BaseSettings
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Settings/TwoFactor/AppSpecific.php

@@ -5,7 +5,7 @@ namespace Friendica\Module\Settings\TwoFactor;
 use Friendica\Core\Renderer;
 use Friendica\DI;
 use Friendica\Model\TwoFactor\AppSpecificPassword;
-use Friendica\Module\BaseSettingsModule;
+use Friendica\Module\BaseSettings;
 use Friendica\Module\Security\Login;
 
 /**
@@ -13,7 +13,7 @@ use Friendica\Module\Security\Login;
  *
  * @package Friendica\Module\TwoFactor
  */
-class AppSpecific extends BaseSettingsModule
+class AppSpecific extends BaseSettings
 {
 	private static $appSpecificPassword = null;
 

src/Module/Settings/TwoFactor/Index.php

@@ -8,11 +8,11 @@ use Friendica\DI;
 use Friendica\Model\TwoFactor\AppSpecificPassword;
 use Friendica\Model\TwoFactor\RecoveryCode;
 use Friendica\Model\User;
-use Friendica\Module\BaseSettingsModule;
+use Friendica\Module\BaseSettings;
 use Friendica\Module\Security\Login;
 use PragmaRX\Google2FA\Google2FA;
 
-class Index extends BaseSettingsModule
+class Index extends BaseSettings
 {
 	public static function post(array $parameters = [])
 	{

src/Module/Settings/TwoFactor/Recovery.php

@@ -5,7 +5,7 @@ namespace Friendica\Module\Settings\TwoFactor;
 use Friendica\Core\Renderer;
 use Friendica\DI;
 use Friendica\Model\TwoFactor\RecoveryCode;
-use Friendica\Module\BaseSettingsModule;
+use Friendica\Module\BaseSettings;
 use Friendica\Module\Security\Login;
 
 /**
@@ -13,7 +13,7 @@ use Friendica\Module\Security\Login;
  *
  * @package Friendica\Module\TwoFactor
  */
-class Recovery extends BaseSettingsModule
+class Recovery extends BaseSettings
 {
 	public static function init(array $parameters = [])
 	{

src/Module/Settings/TwoFactor/Verify.php

@@ -9,7 +9,7 @@ use BaconQrCode\Writer;
 use Friendica\Core\Renderer;
 use Friendica\Core\Session;
 use Friendica\DI;
-use Friendica\Module\BaseSettingsModule;
+use Friendica\Module\BaseSettings;
 use Friendica\Module\Security\Login;
 use PragmaRX\Google2FA\Google2FA;
 
@@ -18,7 +18,7 @@ use PragmaRX\Google2FA\Google2FA;
  *
  * @package Friendica\Module\TwoFactor\Settings
  */
-class Verify extends BaseSettingsModule
+class Verify extends BaseSettings
 {
 	public static function init(array $parameters = [])
 	{

src/Module/Settings/UserExport.php

@@ -11,12 +11,12 @@ use Friendica\Core\Renderer;
 use Friendica\Database\DBA;
 use Friendica\Database\DBStructure;
 use Friendica\DI;
-use Friendica\Module\BaseSettingsModule;
+use Friendica\Module\BaseSettings;
 
 /**
  * Module to export user data
  **/
-class UserExport extends BaseSettingsModule
+class UserExport extends BaseSettings
 {
 	/**
 	 * Handle the request to export data.