Skip to content

#41 [Shortener] add: rework extrafields + lib #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nicolas-eoxia wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

#41 [Shortener] add: rework extrafields + lib #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ac8403
#41 [Shortener] add: rework extrafields + lib
nicolas-eoxia Feb 19, 2025
7ba7015
#41[admin] fix: improve check on detect Yourls API
nicolas-eoxia Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 16 additions & 37 deletions admin/setup.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@

// Load EasyURL libraries
require_once __DIR__ . '/../lib/easyurl.lib.php';
require_once __DIR__ . '/../lib/easyurl_function.lib.php';

// Global variables definitions
global $conf, $db, $langs, $user;
Expand All @@ -58,45 +59,23 @@
*/

if ($action == 'set_config') {
$URLYourlsAPI = GETPOST('url_yourls_api');
$signatureTokenYourlsAPI = GETPOST('signature_token_yourls_api');
$defaultOriginalURL = GETPOST('default_original_url');

if (dol_strlen($URLYourlsAPI) > 0) {
dolibarr_set_const($db, 'EASYURL_URL_YOURLS_API', $URLYourlsAPI, 'chaine', 0, '', $conf->entity);
}
if (dol_strlen($signatureTokenYourlsAPI) > 0) {
dolibarr_set_const($db, 'EASYURL_SIGNATURE_TOKEN_YOURLS_API', $signatureTokenYourlsAPI, 'chaine', 0, '', $conf->entity);
}

if (dol_strlen($URLYourlsAPI) > 0 && dol_strlen($signatureTokenYourlsAPI) > 0) {

// Init the CURL session
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, GETPOST('url_yourls_api'));
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Return, do not echo result
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POST, 1); // This is a POST request

curl_setopt($ch, CURLOPT_POSTFIELDS, [ // Data to POST
'signature' => getDolGlobalString('EASYURL_SIGNATURE_TOKEN_YOURLS_API'),
'format' => 'json'
]);

$data = curl_exec($ch);
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

// 400 when no actions set and credentials ok
if ($statusCode != 400) {
setEventMessage('WarningApiCredentialsIncorrect', 'warnings');
$APISettings = ['url_yourls_api', 'signature_token_yourls_api', 'default_original_url'];
foreach ($APISettings as $APISetting) {
$APISettingValue = GETPOST($APISetting);
$confName = 'EASYURL_' . dol_strtoupper($APISetting);
if (dol_strlen($APISettingValue) > 0) {
dolibarr_set_const($db, $confName, $APISettingValue, 'chaine', 0, '', $conf->entity);
}
}

dolibarr_set_const($db, 'EASYURL_DEFAULT_ORIGINAL_URL', $defaultOriginalURL, 'chaine', 0, '', $conf->entity);
$curlPostFields = ['action' => 'version'];
$data = init_easy_url_curl($curlPostFields);
if (empty($data) || (isset($data->errorCode) && $data->errorCode != 200)) {
setEventMessages('ErrorEasyURLAPIConfig', [], 'errors');
} else {
setEventMessages('SavedConfig', []);
}

setEventMessage('SavedConfig');
header('Location: ' . $_SERVER['PHP_SELF']);
exit;
}
Expand Down Expand Up @@ -133,12 +112,12 @@

print '<tr class="oddeven"><td><label for="url_yourls_api">' . $langs->trans('URLYourlsAPI') . '</label></td>';
print '<td>' . $langs->trans('URLYourlsAPIDescription') . '</td>';
print '<td><input class="minwidth300" type="text" name="url_yourls_api" value="' . $conf->global->EASYURL_URL_YOURLS_API . '"></td>';
print '<td><input class="minwidth300" type="text" name="url_yourls_api" value="' . $conf->global->EASYURL_URL_YOURLS_API . '" required></td>';
print '</td></tr>';

print '<tr class="oddeven"><td><label for="signature_token_yourls_api">' . $langs->trans('SignatureTokenYourlsAPI') . '</label></td>';
print '<td>' . $langs->trans('SignatureTokenYourlsAPIDescription') . '</td>';
print '<td><input class="minwidth300" type="password" name="signature_token_yourls_api" value="' . $conf->global->EASYURL_SIGNATURE_TOKEN_YOURLS_API . '"></td>';
print '<td><input class="minwidth300" type="password" name="signature_token_yourls_api" value="' . $conf->global->EASYURL_SIGNATURE_TOKEN_YOURLS_API . '" required></td>';
print '</td></tr>';

print '<tr class="oddeven"><td><label for="default_original_url">' . $langs->trans('DefaultOriginalUrl') . '</label></td>';
Expand Down
60 changes: 1 addition & 59 deletions class/actions_easyurl.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,36 +73,7 @@ public function __construct(DoliDB $db)
*/
public function printCommonFooter(array $parameters): int
{
global $object, $langs;

if (in_array($parameters['currentcontext'], ['propalcard', 'ordercard', 'invoicecard', 'contractcard', 'interventioncard'])) {
if ($object->status > $object::STATUS_DRAFT) {
$cssPath = dol_buildpath('/saturne/css/saturne.min.css', 1);
print '<link href="' . $cssPath . '" rel="stylesheet">';

$pictoPath = dol_buildpath('/easyurl/img/easyurl_color.png', 1);
$picto = img_picto('', $pictoPath, '', 1, 0, 0, '', 'pictoModule');
$urlTypes = ['payment', 'signature'];
foreach ($urlTypes as $urlType) {
$shortenerData = get_easy_url_link($object, $urlType);
$jQueryElement = '.' . $object->element . '_extras_easy_url_' . $urlType . '_link';
if ($shortenerData->statusCode != 200 && getDolGlobalInt('EASYURL_MANUAL_GENERATION')) {
$output = $picto;
$output .= '<a class="reposition editfielda" href="' . $_SERVER['PHP_SELF'] . '?id=' . $object->id . '&action=set_easy_url&url_type=' . $urlType . '&token=' . newToken() . '">';
$output .= img_picto($langs->trans('SetEasyURLLink'), 'fontawesome_fa-redo_fas_#444', 'class="paddingright pictofixedwidth valignmiddle"') . '</a>';
$output .= '</span>' . img_picto($langs->trans('GetEasyURLErrors'), 'fontawesome_fa-exclamation-triangle_fas_#bc9526') . '</span>';
}
if (!empty($object->array_options['options_easy_url_' . $urlType . '_link']) && $shortenerData->statusCode == 200) {
$output = showValueWithClipboardCPButton($object->array_options['options_easy_url_' . $urlType . '_link'], 0, 'none');
} ?>
<script>
var objectElement = <?php echo "'" . $jQueryElement . "'"; ?>;
jQuery(objectElement).prepend(<?php echo json_encode($output); ?>);
</script>
<?php
}
}
}
global $object;

require_once __DIR__ . '/../../saturne/lib/object.lib.php';

Expand Down Expand Up @@ -130,26 +101,6 @@ public function printCommonFooter(array $parameters): int
}
}

if (in_array($parameters['currentcontext'], ['propallist', 'orderlist', 'invoicelist'])) {
$cssPath = dol_buildpath('/saturne/css/saturne.min.css', 1);
print '<link href="' . $cssPath . '" rel="stylesheet">';

$pictoPath = dol_buildpath('/easyurl/img/easyurl_color.png', 1);
$picto = img_picto('', $pictoPath, '', 1, 0, 0, '', 'pictoModule');
$urlTypes = ['payment', 'signature'];
foreach ($urlTypes as $urlType) {
$jQueryElement = 'easy_url_' . $urlType . '_link'; ?>

<script>
var objectElement = <?php echo "'" . $jQueryElement . "'"; ?>;
var outJS = <?php echo json_encode($picto); ?>;
var cell = $('.liste > tbody > tr.liste_titre').find('th[data-titlekey="' + objectElement + '"]');
cell.prepend(outJS);
</script>
<?php
}
}

return 0; // or return 1 to replace standard code
}

Expand All @@ -165,15 +116,6 @@ public function doActions(array $parameters, $object, string $action): int
{
global $conf, $user;

if (in_array($parameters['currentcontext'], ['propalcard', 'ordercard', 'invoicecard', 'contractcard', 'interventioncard'])) {
if ($action == 'set_easy_url') {
set_easy_url_link($object, GETPOST('url_type'));

header('Location: ' . $_SERVER['PHP_SELF'] . '?id=' . $object->id);
exit;
}
}

require_once __DIR__ . '/../../saturne/lib/object.lib.php';

$objectsMetadata = saturne_get_objects_metadata();
Expand Down
2 changes: 1 addition & 1 deletion class/shortener.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,7 +553,7 @@ public function displayObjectDetails(CommonObject $object): string
$out .= '<td>' . ($user->conf->EASYURL_SHOW_QRCODE ? saturne_show_medias_linked('easyurl', $conf->easyurl->multidir_output[$conf->entity] . '/shortener/' . $shortener->ref . '/qrcode/', 'small', 1, 0, 0, 0, 80, 80, 0, 0, 1, 'shortener/'. $shortener->ref . '/qrcode/', $shortener, '', 0, 0) : $shortener->showOutputField($this->fields['short_url'], 'short_url', $shortener->short_url)) . '</td>';
$out .= '<td>' . $shortener->showOutputField($this->fields['original_url'], 'original_url', $shortener->original_url) . '</td>';
if (getDolGlobalInt('EASYURL_SHOW_API_INFOS')) {
$shortenerData = get_easy_url_link($object, 'all');
$shortenerData = get_easy_url_link($shortener->short_url);
$out .= '<td>' . (isset($shortenerData->link) && isset($shortenerData->link->clicks) ? $shortenerData->link->clicks : 0) . '</td>';
}
if ($user->hasRight('easyurl', 'shortener', 'write')) {
Expand Down
88 changes: 59 additions & 29 deletions core/modules/modEasyURL.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ public function __construct($db)
*/
public function init($options = ''): int
{
global $conf;
global $conf, $user;

// Permissions
$this->remove($options);
Expand All @@ -408,35 +408,65 @@ public function init($options = ''): int
dolibarr_set_const($this->db, 'EASYURL_VERSION', $this->version, 'chaine', 0, '', $conf->entity);
dolibarr_set_const($this->db, 'EASYURL_DB_VERSION', $this->version, 'chaine', 0, '', $conf->entity);

// Create extrafields during init
require_once DOL_DOCUMENT_ROOT . '/core/class/extrafields.class.php';
$extraFields = new ExtraFields($this->db);

// Propal extrafields
$extraFields->update('easy_url_signature_link', 'EasyUrlSignatureLink', 'url', '', 'propal', 0, 0, 2000, '', '', '', 5, 'EasyUrlLinkHelp', '', '', 0, 'easyurl@easyurl');
$extraFields->addExtraField('easy_url_signature_link', 'EasyUrlSignatureLink', 'url', 2000, '', 'propal', 0, 0, '', '', '', '', 5, 'EasyUrlLinkHelp', '', 0, 'easyurl@easyurl');

// Order extrafields
$extraFields->update('easy_url_payment_link', 'EasyUrlPaymentLink', 'url', '', 'commande', 0, 0, 2000, '', '', '', 5, 'EasyUrlLinkHelp', '', '', 0, 'easyurl@easyurl');
$extraFields->addExtraField('easy_url_payment_link', 'EasyUrlPaymentLink', 'url', 2000, '', 'commande', 0, 0, '', '', '', '', 5, 'EasyUrlLinkHelp', '', 0, 'easyurl@easyurl');

// Invoice extrafields
$extraFields->update('easy_url_payment_link', 'EasyUrlPaymentLink', 'url', '', 'facture', 0, 0, 2000, '', '', '', 5, 'EasyUrlLinkHelp', '', '', 0, 'easyurl@easyurl');
$extraFields->addExtraField('easy_url_payment_link', 'EasyUrlPaymentLink', 'url', 2000, '', 'facture', 0, 0, '', '', '', '', 5, 'EasyUrlLinkHelp', '', 0, 'easyurl@easyurl');

// Contract extrafields
$extraFields->update('easy_url_signature_link', 'EasyUrlSignatureLink', 'url', '', 'contrat', 0, 0, 2000, '', '', '', 5, 'EasyUrlLinkHelp', '', '', 0, 'easyurl@easyurl');
$extraFields->addExtraField('easy_url_signature_link', 'EasyUrlSignatureLink', 'url', 2000, '', 'contrat', 0, 0, '', '', '', '', 5, 'EasyUrlLinkHelp', '', 0, 'easyurl@easyurl');

// Fiche inter extrafields
$extraFields->update('easy_url_signature_link', 'EasyUrlSignatureLink', 'url', '', 'fichinter', 0, 0, 2000, '', '', '', 5, 'EasyUrlLinkHelp', '', '', 0, 'easyurl@easyurl');
$extraFields->addExtraField('easy_url_signature_link', 'EasyUrlSignatureLink', 'url', 2000, '', 'fichinter', 0, 0, '', '', '', '', 5, 'EasyUrlLinkHelp', '', 0, 'easyurl@easyurl');
if (!getDolGlobalInt('EASYURL_BACKWARD_EXTRAFIELDS') && version_compare(getDolGlobalString('EASYURL_VERSION'), '1.1.0', '>=')) {
// Create extrafields during init
require_once DOL_DOCUMENT_ROOT . '/core/class/extrafields.class.php';

require_once __DIR__ . '/../../lib/easyurl_function.lib.php';

$extraFields = new ExtraFields($this->db);

$extraFields->update('easy_url_signature_link', 'EasyUrlSignatureLink', 'url', '', 'propal', 0, 0, 2000, '', '', '', 0, 'EasyUrlLinkHelp', '', '', 0, 'easyurl@easyurl');
$extraFields->update('easy_url_payment_link', 'EasyUrlPaymentLink', 'url', '', 'commande', 0, 0, 2000, '', '', '', 0, 'EasyUrlLinkHelp', '', '', 0, 'easyurl@easyurl');
$extraFields->update('easy_url_payment_link', 'EasyUrlPaymentLink', 'url', '', 'facture', 0, 0, 2000, '', '', '', 0, 'EasyUrlLinkHelp', '', '', 0, 'easyurl@easyurl');
$extraFields->update('easy_url_signature_link', 'EasyUrlSignatureLink', 'url', '', 'contrat', 0, 0, 2000, '', '', '', 0, 'EasyUrlLinkHelp', '', '', 0, 'easyurl@easyurl');
$extraFields->update('easy_url_signature_link', 'EasyUrlSignatureLink', 'url', '', 'fichinter', 0, 0, 2000, '', '', '', 0, 'EasyUrlLinkHelp', '', '', 0, 'easyurl@easyurl');

// All element type extrafields
$shortenerUrlTypeDictionaries = saturne_fetch_dictionary('c_shortener_url_type');
$objectsMetadata = saturne_get_objects_metadata();
foreach ($objectsMetadata as $objectMetadata) {
$objects = saturne_fetch_all_object_type($objectMetadata['class_name'], '', '', 0, 0, [], 'AND', true);
if (is_array($objects) && !empty($objects)) {
foreach ($objects as $object) {
$urlTypes = ['signature', 'payment'];
foreach ($urlTypes as $urlType) {
if (isset($object->array_options['options_easy_url_' . $urlType . '_link']) && !empty($object->array_options['options_easy_url_' . $urlType . '_link'])) {
Copy link

@evarisk-kilyan evarisk-kilyan Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pourquoi ne pas utiliser !empty() pour les deux

$shortener = new Shortener($this->db);

$result = $shortener->fetch('', '', ' AND short_url = "' . $object->array_options['options_easy_url_' . $urlType . '_link'] . '"');
if ($result == 0) {
$shortenerData = get_easy_url_link($object->array_options['options_easy_url_' . $urlType . '_link']);

$shortener->ref = $shortener->getNextNumRef();
$shortener->ref_ext = 'easy_url_' . $urlType . '_link';
$shortener->entity = $conf->entity;
$shortener->status = Shortener::STATUS_ASSIGN;
$shortener->label = $shortenerData->title;
$shortener->short_url = $object->array_options['options_easy_url_' . $urlType . '_link'];
$shortener->original_url = $shortenerData->url;
if (is_array($shortenerUrlTypeDictionaries) && !empty($shortenerUrlTypeDictionaries)) {
foreach ($shortenerUrlTypeDictionaries as $shortenerUrlTypeDictionary) {
if ($shortenerUrlTypeDictionary->ref == ucfirst($urlType)) {
$shortener->type = $shortenerUrlTypeDictionary->id;
break;
}
}
}
$shortener->methode = 'yourls';
$shortener->element_type = $objectMetadata['tab_type'];
$shortener->fk_element = $object->id;

$shortener->create($user);
}
}
}
}
}
$extraFields->update('easy_url_all_link', 'EasyUrlAllLink', 'url', '', $objectMetadata['table_element'], 0, 0, 2100, '', '', '', 0, 'EasyUrlAllLinkHelp', '', '', 0, 'easyurl@easyurl');
}

// All element type extrafields
$objectsMetadata = saturne_get_objects_metadata();
foreach($objectsMetadata as $objectMetadata) {
$extraFields->update('easy_url_all_link', 'EasyUrlAllLink', 'url', '', $objectMetadata['table_element'], 0, 0, 2100, '', '', '', 5, 'EasyUrlAllLinkHelp', '', '', 0, 'easyurl@easyurl');
$extraFields->addExtraField('easy_url_all_link', 'EasyUrlAllLink', 'url', 2100, '', $objectMetadata['table_element'], 0, 0, '', '', '', '', 5, 'EasyUrlAllLinkHelp', '', 0, 'easyurl@easyurl');
dolibarr_set_const($this->db, 'EASYURL_BACKWARD_EXTRAFIELDS', 1, 'integer', 0, '', $conf->entity);
}

return $this->_init($sql, $options);
Expand Down
26 changes: 11 additions & 15 deletions core/substitutions/functions_easyurl.lib.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,22 +33,18 @@
*/
function easyurl_completesubstitutionarray(&$substitutionarray, $langs, $object)
{
global $db;

$langs->load('easyurl@easyurl');
if (isset($object->element)) {
switch ($object->element) {
case 'propal' :
case 'contrat' :
case 'fichinter' :
$substitutionarray['__EASY_URL_SIGNATURE_LINK__'] = $object->array_options['options_easy_url_signature_link'];
break;
case 'commande' :
case 'facture' :
$substitutionarray['__EASY_URL_PAYMENT_LINK__'] = $object->array_options['options_easy_url_payment_link'];
break;
default :
$substitutionarray['__EASY_URL_SIGNATURE_LINK__'] = $langs->trans('EasyUrlSignatureLink');
$substitutionarray['__EASY_URL_PAYMENT_LINK__'] = $langs->trans('EasyUrlPaymentLink');
break;

require_once __DIR__ . '/../../class/shortener.class.php';

$shortener = new Shortener($db);

$shorteners = $shortener->fetchAll('', '', 0,0, ['customsql' => 'fk_element = ' . $object->id . ' AND type > 0']);
if (is_array($shorteners) && !empty($shorteners)) {
foreach ($shorteners as $shortener) {
$substitutionarray['__EASY_URL_' . dol_strtoupper(getDictionaryValue('c_shortener_url_type', 'label', $shortener->type)) . '_LINK__'] = $shortener->short_url;
}
}
}
Loading