FindMeFollowMe API Broken

sholinaty · November 1, 2021, 9:10pm

starting a thread around: https://issues.freepbx.org/browse/FREEPBX-22986

Goal:
I want to set FindMeFollowMe via the API, as designed

Problem:
~~someone submitted/approved broken code~~
an HTTP PUT call to /admin/api/api/rest/findmefollow/users/5136 fails
error is:

{
    "error": {
        "type": "Whoops\\Exception\\ErrorException",
        "message": "Call to undefined function FreePBX\\modules\\Findmefollow\\Api\\Rest\\findmefollow_del()",
        "file": "/var/www/html/admin/modules/findmefollow/Api/Rest/Findmefollow.php",
        "line": 45
    }
}

but what does that MEAN?

the PUT step here: https://github.com/FreePBX/findmefollow/blob/release/15.0/Api/Rest/Findmefollow.php#L45
calls findmefollow_del($args[‘id’]);

which doesn’t exist in

github.com

FreePBX/findmefollow/blob/release/15.0/Findmefollow.class.php

<?php
namespace FreePBX\modules;
// vim: set ai ts=4 sw=4 ft=php:
//	License for all code of this FreePBX module can be found in the license file inside the module directory
//	Copyright 2013 Schmooze Com Inc.
//
class Findmefollow implements \BMO {

	public function __construct($freepbx = null) {
		if ($freepbx == null) {
			throw new Exception("Not given a FreePBX Object");
		}

		$this->FreePBX = $freepbx;
		$this->db = $freepbx->Database;
	}

	public function doConfigPageInit($page) {
		global $amp_conf;
		if(!isset($_REQUEST['action'])){

This file has been truncated. show original

sholinaty · November 1, 2021, 9:10pm

but there IS a del() command…

github.com

FreePBX/findmefollow/blob/release/15.0/Findmefollow.class.php#L762


			}


			$astman->database_put("AMPUSER",$grpnum."/followme/changecid",$changecid);
			$fixedcid = preg_replace("/[^0-9\+]/" ,"", trim($fixedcid));
			$astman->database_put("AMPUSER",$grpnum."/followme/fixedcid",$fixedcid);
		} else {
			\fatal("Cannot connect to Asterisk Manager with ".$conf->get("AMPMGRUSER")."/".$conf->get("AMPMGRPASS"));
		}
	}


	public function del($grpnum) {
		$astman = $this->FreePBX->astman;
		$dbh = $this->db;
		$conf = $this->FreePBX->Config();


		$sql= "DELETE FROM findmefollow WHERE grpnum = :grpnum";
		$stmt = $dbh->prepare($sql);
		$results = $stmt->execute(array(':grpnum' => $grpnum));
		if ($astman) {
			$astman->database_deltree("AMPUSER/".$grpnum."/followme");
		} else {

sholinaty · November 1, 2021, 9:13pm

BREADCRUMB!
the findmefollow_get is explicitly defined (thats janky AF…)

github.com

FreePBX/findmefollow/blob/b04baa39416fc3d9e6ab2205a7521fd951d478ac/functions.inc.php#L1137


		$action			= isset($_REQUEST['action'])		? $_REQUEST['action']			: null;
		$extdisplay		= isset($_REQUEST['extdisplay'])	? $_REQUEST['extdisplay']		: null;
		$extension		= isset($_REQUEST['extension'])		? $_REQUEST['extension']		: null;
		$tech_hardware	= isset($_REQUEST['tech_hardware'])	? $_REQUEST['tech_hardware']	: null;
		if ($tech_hardware != null || $action == "add" || $extdisplay != '') {
			findmefollow_users_configpageinit($dispnum);
		}
	}
}


function findmefollow_get($grpnum, $check_astdb=0) {
	return FreePBX::Findmefollow()->get($grpnum, $check_astdb);
}


// we only return the destination that other modules might use, e.g. extenions/users
function findmefollow_getdest($exten) {
	return array('ext-findmefollow,FM' . $exten . ',1');
}


function findmefollow_getdestinfo($dest) {
	if (substr(trim($dest),0,17) == 'ext-findmefollow,' || substr(trim($dest),0,10) == 'ext-local,' && substr(trim($dest),-4) == 'dest') {

so we must just be missing it in the del.

sholinaty · November 1, 2021, 9:24pm

first (?) Pull request: https://git.freepbx.org/projects/FREEPBX/repos/findmefollow/pull-requests/38/overview

turns out the del( function exists already, it was just not actually tied to the findmefollow_del that was trying to call it.

sholinaty · November 2, 2021, 5:22pm

@lgaetz hoping for a 2nd set of eyes…

Findmefollow_add seems to pass a big pile of comma separated args to a function that doesn’t exist…

github.com

FreePBX/findmefollow/blob/release/15.0/Api/Rest/Findmefollow.php#L46




		/**
		* @verb PUT
		* @uri /findmefollow/users/:id
		*/
		$app->put('/users/{id}', function ($request, $response, $args) {
			\FreePBX::Modules()->loadFunctionsInc('findmefollow');
			$params = $request->getParsedBody();


			findmefollow_del($args['id']);
			return $response->withJson(findmefollow_add(
				$args['id'],
				$params['strategy'],
				$params['grptime'],
				$params['grplist'],
				$params['postdest'],
				$params['grppre'],
				$params['annmsg_id'],
				$params['dring'],
				$params['needsconf'],
				$params['remotealert_id'],

but the ADD takes in… a $Data blob, which has to be an array?

github.com

FreePBX/findmefollow/blob/b04baa39416fc3d9e6ab2205a7521fd951d478ac/Findmefollow.class.php#L641


					'reset' => array(
						'name' => 'reset',
						'id' => 'reset',
						'value' => _('Reset')
					)
				);
				break;
		}
		return $buttons;
	}
	function add($grpnum,$data) {
		if(!is_array($data)) {
			throw new \Exception("The format for adding a fmfm has changed. Please fix the calling code to reflect this");
		}
		$defaults = array(
			'strategy' => $this->FreePBX->Config->get('FOLLOWME_RG_STRATEGY'),
			'grptime' => $this->FreePBX->Config->get('FOLLOWME_TIME'),
			'grplist' => $grpnum,
			'postdest' => 'ext-local,'.$grpnum.',dest',
			'grppre' => '',
			'annmsg_id' => '',

more specifically… I just need to map the rest 'findmefollow_add" through an intermediary function to create an array from the list of params, then we should be good to call add properly…

does that pass a sanity check?

lgaetz · November 2, 2021, 5:49pm

Not something I have personal knowledge of. All engineering is pretty much focused on Astricon this week (most will be reachable at https://astricon.slack.com). Prob best to open a ticket with your findings and engineering can review when they come up for air next week.

sholinaty · November 2, 2021, 6:09pm

how did i nearly miss astricon?!
time to burn the sprint, and gain some knowledge!

sholinaty · November 2, 2021, 7:43pm

re-created the PR with a single commit, to get delete and ADD working in the same commit (for history / changelog)

https://git.freepbx.org/projects/FREEPBX/repos/findmefollow/pull-requests/39/overview

sholinaty · November 8, 2021, 7:06pm

Some progress… but not enough.

the current EDGE module, the Delete works.
but the following Add for FindMeFollow is failing. trying to sort out why.

sholinaty · November 8, 2021, 9:44pm

got it fixed, and functionally tested.
waiting for the next Pull Request to get merged.

system · December 9, 2021, 9:44pm

This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.