ts3admin.class.php

SUBMITTED BY: Todlich

DATE: Aug. 13, 2016, 6:27 p.m.

FORMAT: Text only

SIZE: 67.5 kB

Raw Download

HITS: 949

Report
  1. <?PHP
  2. /**
  3. * ts3admin.class.php
  4. * ------------------
  5. * begin : 18. December 2009
  6. * copyright : (C) 2009-2013 Par0noid Solutions
  7. * email : contact@ts3admin.info
  8. * version : 0.7.0.0
  9. * last modified : 28. January 2014
  10. *
  11. *
  12. * This file is a powerful library for querying TeamSpeak3 servers.
  13. *
  14. * This program is free software: you can redistribute it and/or modify
  15. * it under the terms of the GNU General Public License as published by
  16. * the Free Software Foundation, either version 3 of the License, or
  17. * (at your option) any later version.
  18. *
  19. * This program is distributed in the hope that it will be useful,
  20. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  22. * GNU General Public License for more details.
  23. *
  24. * You should have received a copy of the GNU General Public License
  25. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  26. */
  28. /**
  29. * The ts3admin.class.php is a powerful library that offers functions to communicate with Teamspeak 3 Servers from your website!
  30. *
  31. * You can do everything, your creativity knows no bounds!
  32. * That library is faster than all other librarys because its optimized to find the shortest way to your information.
  33. * No unneeded PHP 5 OOP Stuff, just the basics!
  34. * There are a lot of professional developers and some big companys using my library.
  35. * The best thing is that you can use it for free under the terms of the GNU General Public License v3.
  36. * Take a look on the project website where you can find code examples, a manual and some other stuff.
  37. *
  38. * @author Par0noid Solutions <contact@ts3admin.info>
  39. * @version 0.7.0.0
  40. * @copyright Copyright (c) 2009-2014, Stefan Z.
  41. * @package ts3admin
  42. * @link http://ts3admin.info
  43. */
  45. class ts3admin {
  47. //*******************************************************************************************
  48. //****************************************** Vars *******************************************
  49. //*******************************************************************************************
  51. /**
  52. * runtime is an private handle and configuration storage
  53. *
  54. * @author Par0noid Solutions
  55. * @access private
  56. */
  57. private $runtime = array('socket' => '', 'selected' => false, 'host' => '', 'queryport' => '10011', 'timeout' => 2, 'debug' => array(), 'fileSocket' => '');
  60. //*******************************************************************************************
  61. //************************************ Public Functions *************************************
  62. //******************************************************************************************
  64. /**
  65. * banAddByIp
  66. *
  67. * Adds a new ban rule on the selected virtual server.
  68. *
  69. * <b>Output:</b>
  70. * <code>
  71. * Array
  72. * {
  73. * [banid] => 109
  74. * }
  75. * </code>
  76. *
  77. * @author Par0noid Solutions
  78. * @access public
  79. * @param string $ip clientIp
  80. * @param integer $time bantime in seconds (0=unlimited)
  81. * @param string $banreason Banreason [optional]
  82. * @return array banId
  83. */
  84. function banAddByIp($ip, $time, $banreason = NULL) {
  85. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  87. if(!empty($banreason)) { $msg = ' banreason='.$this->escapeText($banreason); } else { $msg = NULL; }
  89. return $this->getData('array', 'banadd ip='.$ip.' time='.$time.$msg);
  90. }
  92. /**
  93. * banAddByUid
  94. *
  95. * Adds a new ban rule on the selected virtual server.
  96. *
  97. * <b>Output:</b>
  98. * <code>
  99. * Array
  100. * {
  101. * [banid] => 110
  102. * }
  103. * </code>
  104. *
  105. * @author Par0noid Solutions
  106. * @access public
  107. * @param string $uid clientUniqueId
  108. * @param integer $time bantime in seconds (0=unlimited)
  109. * @param string $banreason Banreason [optional]
  110. * @return array banId
  111. */
  112. function banAddByUid($uid, $time, $banreason = NULL) {
  113. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  115. if(!empty($banreason)) { $msg = ' banreason='.$this->escapeText($banreason); } else { $msg = NULL; }
  117. return $this->getData('array', 'banadd uid='.$uid.' time='.$time.$msg);
  118. }
  120. /**
  121. * banAddByName
  122. *
  123. * Adds a new ban rule on the selected virtual server.
  124. *
  125. * <b>Output:</b>
  126. * <code>
  127. * Array
  128. * {
  129. * [banid] => 111
  130. * }
  131. * </code>
  132. *
  133. * @author Par0noid Solutions
  134. * @access public
  135. * @param string $name clientName
  136. * @param integer $time bantime in seconds (0=unlimited)
  137. * @param string $banreason Banreason [optional]
  138. * @return array banId
  139. */
  140. function banAddByName($name, $time, $banreason = NULL) {
  141. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  143. if(!empty($banreason)) { $msg = ' banreason='.$this->escapeText($banreason); } else { $msg = NULL; }
  145. return $this->getData('array', 'banadd name='.$this->escapeText($name).' time='.$time.$msg);
  146. }
  148. /**
  149. * banClient
  150. *
  151. * Bans the client specified with ID clid from the server. Please note that this will create two separate ban rules for the targeted clients IP address and his unique identifier.
  152. *
  153. * <b>Output:</b>
  154. * <code>
  155. * Array
  156. * {
  157. * [1] => 129
  158. * [2] => 130
  159. * }
  160. * </code>
  161. *
  162. * @author Par0noid Solutions
  163. * @access public
  164. * @param integer $clid clientId
  165. * @param integer $time bantime in seconds (0=unlimited)
  166. * @param string $banreason Banreason [optional]
  167. * @return array banIds
  168. */
  169. function banClient($clid, $time, $banreason = NULL) {
  170. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  172. if(!empty($banreason)) { $msg = ' banreason='.$this->escapeText($banreason); } else { $msg = ''; }
  174. $result = $this->getData('plain', 'banclient clid='.$clid.' time='.$time.$msg);
  176. if($result['success']) {
  177. return $this->generateOutput(true, $result['errors'], $this->splitBanIds($result['data']));
  178. }else{
  179. return $this->generateOutput(false, $result['errors'], false);
  180. }
  181. }
  183. /**
  184. * banDelete
  185. *
  186. * Deletes the ban rule with ID banid from the server.
  187. *
  188. * @author Par0noid Solutions
  189. * @access public
  190. * @param integer $banID banID
  191. * @return boolean success
  192. */
  193. function banDelete($banID) {
  194. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  195. return $this->getData('boolean', 'bandel banid='.$banID);
  196. }
  198. /**
  199. * banDeleteAll
  200. *
  201. * Deletes all active ban rules from the server.
  202. *
  203. * @author Par0noid Solutions
  204. * @access public
  205. * @return boolean success
  206. */
  207. function banDeleteAll() {
  208. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  209. return $this->getData('boolean', 'bandelall');
  210. }
  212. /**
  213. * banList
  214. *
  215. * Displays a list of active bans on the selected virtual server.
  216. *
  217. * <b>Output:</b>
  218. * <code>
  219. * Array
  220. * {
  221. * [banid] => 131
  222. * [ip] => 1.2.3.4
  223. * [name] => eugen
  224. * [uid] => IYAntAcZHgVC7s3n3DNWmuJB/aM=
  225. * [created] => 1286660391
  226. * [duration] => 0
  227. * [invokername] => Par0noid
  228. * [invokercldbid] => 2086
  229. * [invokeruid] => nUixbsq/XakrrmbqU8O30R/D8Gc=
  230. * [reason] => insult
  231. * [enforcements] => 0
  232. * }
  233. * </code>
  234. *
  235. * @author Par0noid Solutions
  236. * @access public
  237. * @return array banlist
  238. */
  239. function banList() {
  240. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  241. return $this->getData('multi', 'banlist');
  242. }
  244. /**
  245. * bindingList
  246. *
  247. * Displays a list of IP addresses used by the server instance on multi-homed machines.
  248. *
  249. * <b>Output:</b><br>
  250. * <code>
  251. * Array
  252. * {
  253. * [ip] => 0.0.0.0
  254. * }
  255. * </code>
  256. *
  257. * @author Par0noid Solutions
  258. * @access public
  259. * @return array bindingList
  260. */
  261. function bindingList() {
  262. return $this->getData('multi', 'bindinglist');
  263. }
  265. /**
  266. * channelAddPerm
  267. *
  268. * Adds a set of specified permissions to a channel. Multiple permissions can be added by providing the two parameters of each permission. A permission can be specified by permid or permsid.
  269. *
  270. * <b>Input-Array like this:</b>
  271. * <code>
  272. * $permissions = array();
  273. * $permissions['permissionID'] = 'permissionValue';
  274. * //or you could use Permission Name
  275. * $permissions['permissionName'] = 'permissionValue';
  276. * </code>
  277. *
  278. * @author Par0noid Solutions
  279. * @access public
  280. * @param integer $cid channelId
  281. * @param array $permissions permissions
  282. * @return boolean success
  283. */
  284. function channelAddPerm($cid, $permissions) {
  285. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  287. if(count($permissions) > 0) {
  288. //Permissions given
  290. //Errorcollector
  291. $errors = array();
  293. //Split Permissions to prevent query from overload
  294. $permissions = array_chunk($permissions, 50, true);
  296. //Action for each splitted part of permission
  297. foreach($permissions as $permission_part)
  298. {
  299. //Create command_string for each command that we could use implode later
  300. $command_string = array();
  302. foreach($permission_part as $key => $value)
  303. {
  304. $command_string[] = (is_numeric($key) ? "permid=" : "permsid=").$this->escapeText($key).' permvalue='.$value;
  305. }
  307. $result = $this->getData('boolean', 'channeladdperm cid='.$cid.' '.implode('|', $command_string));
  309. if(!$result['success'])
  310. {
  311. foreach($result['errors'] as $error)
  312. {
  313. $errors[] = $error;
  314. }
  315. }
  316. }
  318. if(count($errors) == 0)
  319. {
  320. return $this->generateOutput(true, array(), true);
  321. }else{
  322. return $this->generateOutput(false, $errors, false);
  323. }
  325. }else{
  326. // No permissions given
  327. $this->addDebugLog('no permissions given');
  328. return $this->generateOutput(false, array('Error: no permissions given'), false);
  329. }
  330. }
  332. /**
  333. * channelClientAddPerm
  334. *
  335. * Adds a set of specified permissions to a client in a specific channel. Multiple permissions can be added by providing the three parameters of each permission. A permission can be specified by permid or permsid.
  336. *
  337. * <b>Input-Array like this:</b>
  338. * <code>
  339. * $permissions = array();
  340. * $permissions['permissionID'] = 'permissionValue';
  341. * //or you could use Permission Name
  342. * $permissions['permissionName'] = 'permissionValue';
  343. * </code>
  344. *
  345. * @author Par0noid Solutions
  346. * @access public
  347. * @param integer $cid channelID
  348. * @param integer $cldbid clientDBID
  349. * @param array $permissions permissions
  350. * @return boolean success
  351. */
  352. function channelClientAddPerm($cid, $cldbid, $permissions) {
  353. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  355. if(count($permissions) > 0) {
  356. //Permissions given
  358. //Errorcollector
  359. $errors = array();
  361. //Split Permissions to prevent query from overload
  362. $permissions = array_chunk($permissions, 50, true);
  364. //Action for each splitted part of permission
  365. foreach($permissions as $permission_part)
  366. {
  367. //Create command_string for each command that we could use implode later
  368. $command_string = array();
  370. foreach($permission_part as $key => $value)
  371. {
  372. $command_string[] = (is_numeric($key) ? "permid=" : "permsid=").$this->escapeText($key).' permvalue='.$value;
  373. }
  375. $result = $this->getData('boolean', 'channelclientaddperm cid='.$cid.' cldbid='.$cldbid.' '.implode('|', $command_string));
  377. if(!$result['success'])
  378. {
  379. foreach($result['errors'] as $error)
  380. {
  381. $errors[] = $error;
  382. }
  383. }
  384. }
  386. if(count($errors) == 0)
  387. {
  388. return $this->generateOutput(true, array(), true);
  389. }else{
  390. return $this->generateOutput(false, $errors, false);
  391. }
  393. }else{
  394. // No permissions given
  395. $this->addDebugLog('no permissions given');
  396. return $this->generateOutput(false, array('Error: no permissions given'), false);
  397. }
  398. }
  400. /**
  401. * channelClientDelPerm
  402. *
  403. * Removes a set of specified permissions from a client in a specific channel. Multiple permissions can be removed at once. A permission can be specified by permid or permsid.
  404. *
  405. * <b>Input-Array like this:</b>
  406. * <code>
  407. * $permissions = array();
  408. * $permissions[] = 'permissionID';
  409. * $permissions[] = 'permissionName';
  410. * //or
  411. * $permissions = array('permissionID', 'permissionName', 'permissionID');
  412. * </code>
  413. *
  414. * @author Par0noid Solutions
  415. * @access public
  416. * @param integer $cid channelID
  417. * @param integer $cldbid clientDBID
  418. * @param array $permissions permissions
  419. * @return boolean success
  420. */
  421. function channelClientDelPerm($cid, $cldbid, $permissions) {
  422. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  423. $permissionArray = array();
  425. if(count($permissions) > 0) {
  426. foreach($permissions AS $value) {
  427. $permissionArray[] = is_numeric($value) ? 'permid='.$value : 'permsid='.$value;
  428. }
  429. return $this->getData('boolean', 'channelclientdelperm cid='.$cid.' cldbid='.$cldbid.' '.implode('|', $permissionArray));
  430. }else{
  431. $this->addDebugLog('no permissions given');
  432. return $this->generateOutput(false, array('Error: no permissions given'), false);
  433. }
  434. }
  436. /**
  437. * channelClientPermList
  438. *
  439. * Displays a list of permissions defined for a client in a specific channel.
  440. *
  441. * <b>Output:</b><br>
  442. * <code>
  443. * Array
  444. * {
  445. * [cid] => 250 (only in first result)
  446. * [cldbid] => 2086 (only in first result)
  447. * [permid] => 12876 (if permsid = false)
  448. * [permsid] => b_client_info_view (if permsid = true)
  449. * [permvalue] => 1
  450. * [permnegated] => 0
  451. * [permskip] => 0
  452. * }
  453. * </code>
  454. *
  455. * @author Par0noid Solutions
  456. * @access public
  457. * @param integer $cid channelID
  458. * @param integer $cldbid clientDBID
  459. * @param boolean $permsid displays permissionName instead of permissionID
  460. * @return array channelclientpermlist
  461. */
  462. function channelClientPermList($cid, $cldbid, $permsid = false) {
  463. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  464. return $this->getData('multi', 'channelclientpermlist cid='.$cid.' cldbid='.$cldbid.($permsid ? ' -permsid' : ''));
  465. }
  467. /**
  468. * channelCreate
  469. *
  470. * Creates a new channel using the given properties and displays its ID. Note that this command accepts multiple properties which means that you're able to specifiy all settings of the new channel at once.
  471. *
  472. * <b style="color:red">Hint:</b> don't forget to set channel_flag_semi_permanent = 1 or channel_flag_permanent = 1
  473. *
  474. * <b style="color:red">Hint:</b> you'll get an error if you want to create a channel without channel_name
  475. *
  476. * <b>Input-Array like this:</b>
  477. * <code>
  478. * $data = array();
  479. *
  480. * $data['setting'] = 'value';
  481. * $data['setting'] = 'value';
  482. * </code>
  483. *
  484. * <b>Output:</b>
  485. * <code>
  486. * Array
  487. * {
  488. * [cid] => 257
  489. * }
  490. * </code>
  491. *
  492. * @author Par0noid Solutions
  493. * @access public
  494. * @param array $data properties
  495. * @return array channelInfo
  496. */
  497. function channelCreate($data) {
  498. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  500. $propertiesString = '';
  502. foreach($data as $key => $value) {
  503. $propertiesString .= ' '.$key.'='.$this->escapeText($value);
  504. }
  506. return $this->getData('array', 'channelcreate '.$propertiesString);
  507. }
  509. /**
  510. * channelDelete
  511. *
  512. * Deletes an existing channel by ID. If force is set to 1, the channel will be deleted even if there are clients within. The clients will be kicked to the default channel with an appropriate reason message.
  513. *
  514. * @author Par0noid Solutions
  515. * @access public
  516. * @param integer $cid channelID
  517. * @param integer $force {1|0} (default: 1)
  518. * @return boolean success
  519. */
  520. function channelDelete($cid, $force = 1) {
  521. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  522. return $this->getData('boolean', 'channeldelete cid='.$cid.' force='.$force);
  523. }
  525. /**
  526. * channelDelPerm
  527. *
  528. * Removes a set of specified permissions from a channel. Multiple permissions can be removed at once. A permission can be specified by permid or permsid.
  529. *
  530. * <b>Input-Array like this:</b>
  531. * <code>
  532. * $permissions = array();
  533. * $permissions[] = 'permissionID';
  534. * //or you could use
  535. * $permissions[] = 'permissionName';
  536. * </code>
  537. *
  538. * @author Par0noid Solutions
  539. * @access public
  540. * @param integer $cid channelID
  541. * @param array $permissions permissions
  542. * @return boolean success
  543. */
  544. function channelDelPerm($cid, $permissions) {
  545. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  546. $permissionArray = array();
  548. if(count($permissions) > 0) {
  549. foreach($permissions AS $value) {
  550. $permissionArray[] = (is_numeric($value) ? 'permid=' : 'permsid=').$value;
  551. }
  552. return $this->getData('boolean', 'channeldelperm cid='.$cid.' '.implode('|', $permissionArray));
  553. }else{
  554. $this->addDebugLog('no permissions given');
  555. return $this->generateOutput(false, array('Error: no permissions given'), false);
  556. }
  557. }
  559. /**
  560. * channelEdit
  561. *
  562. * Changes a channels configuration using given properties. Note that this command accepts multiple properties which means that you're able to change all settings of the channel specified with cid at once.
  563. *
  564. * <b>Input-Array like this:</b>
  565. * <code>
  566. * $data = array();
  567. *
  568. * $data['setting'] = 'value';
  569. * $data['setting'] = 'value';
  570. * </code>
  571. *
  572. * @author Par0noid Solutions
  573. * @access public
  574. * @param integer $cid $channelID
  575. * @param array $data edited settings
  576. * @return boolean success
  577. */
  578. function channelEdit($cid, $data) {
  579. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  581. $settingsString = '';
  583. foreach($data as $key => $value) {
  584. $settingsString .= ' '.$key.'='.$this->escapeText($value);
  585. }
  587. return $this->getData('boolean', 'channeledit cid='.$cid.$settingsString);
  588. }
  590. /**
  591. * channelFind
  592. *
  593. * displays a list of channels matching a given name pattern.
  594. *
  595. * <b>Output:</b>
  596. * <code>
  597. * Array
  598. * {
  599. * [cid] => 2
  600. * [channel_name] => Lobby
  601. * }
  602. * </code>
  603. *
  604. * @author Par0noid Solutions
  605. * @access public
  606. * @param string $pattern channelName
  607. * @return array channelList
  608. */
  609. function channelFind($pattern) {
  610. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  611. return $this->getData('multi', 'channelfind pattern='.$this->escapeText($pattern));
  612. }
  614. /**
  615. * channelGroupAdd
  616. *
  617. * Creates a new channel group using a given name and displays its ID. The optional type parameter can be used to create ServerQuery groups and template groups.
  618. *
  619. * <b>groupDbTypes:</b>
  620. * <ol start="0">
  621. * <li>template group (used for new virtual servers)</li>
  622. * <li>regular group (used for regular clients)</li>
  623. * <li>global query group (used for ServerQuery clients)</li>
  624. * </ol>
  625. *
  626. * <b>Output:</b>
  627. * <code>
  628. * Array
  629. * {
  630. * [cgid] => 86
  631. * }
  632. * </code>
  633. *
  634. * @author Par0noid Solutions
  635. * @access public
  636. * @param integer $name groupName
  637. * @param integer $type groupDbType [optional] (default: 1)
  638. * @return boolean success
  639. */
  640. function channelGroupAdd($name, $type = 1) {
  641. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  642. return $this->getData('array', 'channelgroupadd name='.$this->escapeText($name).' type='.$type);
  643. }
  645. /**
  646. * channelGroupAddPerm
  647. *
  648. * Adds a set of specified permissions to a channel group. Multiple permissions can be added by providing the two parameters of each permission. A permission can be specified by permid or permsid.
  649. *
  650. * <b>Input-Array like this:</b>
  651. * <code>
  652. * $permissions = array();
  653. * $permissions['permissionID'] = 'permissionValue';
  654. * //or you could use:
  655. * $permissions['permissionName'] = 'permissionValue';
  656. * </code>
  657. *
  658. * @author Par0noid Solutions
  659. * @access public
  660. * @param integer $cgid channelGroupID
  661. * @param array $permissions permissions
  662. * @return boolean success
  663. */
  664. function channelGroupAddPerm($cgid, $permissions) {
  665. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  667. if(count($permissions) > 0) {
  668. //Permissions given
  670. //Errorcollector
  671. $errors = array();
  673. //Split Permissions to prevent query from overload
  674. $permissions = array_chunk($permissions, 50, true);
  676. //Action for each splitted part of permission
  677. foreach($permissions as $permission_part)
  678. {
  679. //Create command_string for each command that we could use implode later
  680. $command_string = array();
  682. foreach($permission_part as $key => $value)
  683. {
  684. $command_string[] = (is_numeric($key) ? "permid=" : "permsid=").$this->escapeText($key).' permvalue='.$value;
  685. }
  687. $result = $this->getData('boolean', 'channelgroupaddperm cgid='.$cgid.' '.implode('|', $command_string));
  689. if(!$result['success'])
  690. {
  691. foreach($result['errors'] as $error)
  692. {
  693. $errors[] = $error;
  694. }
  695. }
  696. }
  698. if(count($errors) == 0) {
  699. return $this->generateOutput(true, array(), true);
  700. }else{
  701. return $this->generateOutput(false, $errors, false);
  702. }
  704. }else{
  705. // No permissions given
  706. $this->addDebugLog('no permissions given');
  707. return $this->generateOutput(false, array('Error: no permissions given'), false);
  708. }
  709. }
  711. /**
  712. * channelGroupClientList
  713. *
  714. * Displays all the client and/or channel IDs currently assigned to channel groups. All three parameters are optional so you're free to choose the most suitable combination for your requirement
  715. *
  716. * <b>Output:</b>
  717. * <code>
  718. * Array
  719. * {
  720. * [cid] => 2
  721. * [cldbid] => 9
  722. * [cgid] => 9
  723. * }
  724. * </code>
  725. *
  726. * @author Par0noid Solutions
  727. * @access public
  728. * @param integer $cid channelID [optional]
  729. * @param integer $cldbid clientDBID [optional]
  730. * @param integer $cgid channelGroupID [optional]
  731. * @return array channelGroupClientList
  732. */
  733. function channelGroupClientList($cid = NULL, $cldbid = NULL, $cgid = NULL) {
  734. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  736. return $this->getData('multi', 'channelgroupclientlist'.(!empty($cid) ? ' cid='.$cid : '').(!empty($cldbid) ? ' cldbid='.$cldbid : '').(!empty($cgid) ? ' cgid='.$cgid : ''));
  737. }
  739. /**
  740. * channelGroupCopy
  741. *
  742. * Creates a copy of the channel group specified with scgid. If tcgid is set to 0, the server will create a new group. To overwrite an existing group, simply set tcgid to the ID of a designated target group. If a target group is set, the name parameter will be ignored. The type parameter can be used to create ServerQuery groups and template groups.
  743. *
  744. * <b>groupDbTypes:</b>
  745. * <ol start="0">
  746. * <li>template group (used for new virtual servers)</li>
  747. * <li>regular group (used for regular clients)</li>
  748. * <li>global query group (used for ServerQuery clients)</li>
  749. * </ol>
  750. *
  751. * <b>Output:</b>
  752. * <code>
  753. * Array
  754. * {
  755. * [cgid] => 86
  756. * }
  757. * </code>
  758. *
  759. * @author Par0noid Solutions
  760. * @access public
  761. * @param integer $scgid sourceChannelGroupID
  762. * @param integer $tcgid targetChannelGroupID
  763. * @param integer $name groupName
  764. * @param integer $type groupDbType
  765. * @return array groupId
  766. */
  767. function channelGroupCopy($scgid, $tcgid, $name, $type = 1) {
  768. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  769. return $this->getData('array', 'channelgroupcopy scgid='.$scgid.' tcgid='.$tcgid.' name='.$this->escapeText($name).' type='.$type);
  770. }
  772. /**
  773. * channelGroupDelete
  774. *
  775. * Deletes a channel group by ID. If force is set to 1, the channel group will be deleted even if there are clients within.
  776. *
  777. * @author Par0noid Solutions
  778. * @access public
  779. * @param integer $cgid channelGroupID
  780. * @param integer $force forces deleting channelGroup (default: 1)
  781. * @return boolean success
  782. */
  783. function channelGroupDelete($cgid, $force = 1) {
  784. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  785. return $this->getData('boolean', 'channelgroupdel cgid='.$cgid.' force='.$force);
  786. }
  788. /**
  789. * channelGroupDelPerm
  790. *
  791. * Removes a set of specified permissions from the channel group. Multiple permissions can be removed at once. A permission can be specified by permid or permsid.
  792. *
  793. * <b>Input-Array like this:</b>
  794. * <code>
  795. * $permissions = array();
  796. * $permissions[] = 'permissionID';
  797. * $permissions[] = 'permissionName';
  798. * </code>
  799. *
  800. * @author Par0noid Solutions
  801. * @access public
  802. * @param integer $cgid channelGroupID
  803. * @param array $permissions permissions
  804. * @return boolean success
  805. */
  806. function channelGroupDelPerm($cgid, $permissions) {
  807. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  808. $permissionArray = array();
  810. if(count($permissions) > 0) {
  811. foreach($permissions AS $value) {
  812. $permissionArray[] = (is_numeric($value) ? 'permid=' : 'permsid=').$value;
  813. }
  814. return $this->getData('boolean', 'channelgroupdelperm cgid='.$cgid.' '.implode('|', $permissionArray));
  815. }else{
  816. $this->addDebugLog('no permissions given');
  817. return $this->generateOutput(false, array('Error: no permissions given'), false);
  818. }
  819. }
  821. /**
  822. * channelGroupList
  823. *
  824. * Displays a list of channel groups available on the selected virtual server.
  825. *
  826. * <b>Output:</b>
  827. * <code>
  828. * Array
  829. * {
  830. * [cgid] => 3
  831. * [name] => Testname
  832. * [type] => 0
  833. * [iconid] => 100
  834. * [savedb] => 1
  835. * [sortid] => 0
  836. * [namemode] => 0
  837. * [n_modifyp] => 75
  838. * [n_member_addp] => 50
  839. * [n_member_removep] => 50
  840. * }
  841. * </code>
  842. *
  843. * @author Par0noid Solutions
  844. * @access public
  845. * @return array channelGroupList
  846. */
  847. function channelGroupList() {
  848. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  850. return $this->getData('multi', 'channelgrouplist');
  851. }
  853. /**
  854. * channelGroupPermList
  855. *
  856. * Displays a list of permissions assigned to the channel group specified with cgid.
  857. * If the permsid option is specified, the output will contain the permission names instead of the internal IDs.
  858. *
  859. * <b>Output:</b>
  860. * <code>
  861. * Array
  862. * {
  863. * [permid] => 8471 (displayed if permsid is false)
  864. * [permsid] => i_channel_create_modify_with_codec_latency_factor_min (displayed if permsid is true)
  865. * [permvalue] => 1
  866. * [permnegated] => 0
  867. * [permskip] => 0
  868. * }
  869. * </code>
  870. *
  871. * @author Par0noid Solutions
  872. * @access public
  873. * @param integer $cgid channelGroupID
  874. * @param boolean $permsid permsid
  875. * @return array channelGroupPermlist
  876. */
  877. function channelGroupPermList($cgid, $permsid = false) {
  878. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  879. return $this->getData('multi', 'channelgrouppermlist cgid='.$cgid.($permsid ? ' -permsid' : ''));
  880. }
  882. /**
  883. * channelGroupRename
  884. *
  885. * Changes the name of a specified channel group.
  886. *
  887. * @author Par0noid Solutions
  888. * @access public
  889. * @param integer $cgid groupID
  890. * @param integer $name groupName
  891. * @return boolean success
  892. */
  893. function channelGroupRename($cgid, $name) {
  894. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  895. return $this->getData('boolean', 'channelgrouprename cgid='.$cgid.' name='.$this->escapeText($name));
  896. }
  898. /**
  899. * channelInfo
  900. *
  901. * Displays detailed configuration information about a channel including ID, topic, description, etc.
  903. * <b>Output:</b>
  904. * <code>
  905. * Array
  906. * {
  907. * [pid] => 0
  908. * [channel_name] => Test
  909. * [channel_topic] =>
  910. * [channel_description] =>
  911. * [channel_password] => cc97Pm4oOYq0J9fXDAgiWv/qScQ=
  912. * [channel_codec] => 2
  913. * [channel_codec_quality] => 7
  914. * [channel_maxclients] => -1
  915. * [channel_maxfamilyclients] => -1
  916. * [channel_order] => 1
  917. * [channel_flag_permanent] => 1
  918. * [channel_flag_semi_permanent] => 0
  919. * [channel_flag_default] => 0
  920. * [channel_flag_password] => 0
  921. * [channel_codec_latency_factor] => 1
  922. * [channel_codec_is_unencrypted] => 1
  923. * [channel_flag_maxclients_unlimited] => 1
  924. * [channel_flag_maxfamilyclients_unlimited] => 0
  925. * [channel_flag_maxfamilyclients_inherited] => 1
  926. * [channel_filepath] => files\\virtualserver_1\\channel_2
  927. * [channel_needed_talk_power] => 0
  928. * [channel_forced_silence] => 0
  929. * [channel_name_phonetic] =>
  930. * [channel_icon_id] => 0
  931. * [seconds_empty] => 61 (If it's a temporary channel with a channel delete delay)
  932. * }
  933. * </code>
  934. *
  935. * @author Par0noid Solutions
  936. * @access public
  937. * @param integer $cid channelID
  938. * @return array channelInfo
  939. */
  940. function channelInfo($cid) {
  941. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  942. return $this->getData('array', 'channelinfo cid='.$cid);
  943. }
  945. /**
  946. * channelList
  947. *
  948. * Displays a list of channels created on a virtual server including their ID, order, name, etc. The output can be modified using several command options.
  949. *
  950. * <br><b>Possible parameters:</b> [-topic] [-flags] [-voice] [-limits] [-icon]<br><br>
  951. *
  952. * <b>Output: (without parameters)</b>
  953. * <code>
  954. * Array
  955. * {
  956. * [cid] => 2
  957. * [pid] => 0
  958. * [channel_order] => 1
  959. * [channel_name] => Test
  960. * [total_clients] => 0
  961. * [channel_needed_subscribe_power] => 0
  962. * }
  963. * </code><br>
  964. * <b>Output: (from parameters)</b>
  965. * <code>
  966. * Array
  967. * {
  968. * [-topic] => [channel_topic] => Default Channel has no topic
  969. * [-flags] => [channel_flag_default] => 1
  970. * [-flags] => [channel_flag_password] => 0
  971. * [-flags] => [channel_flag_permanent] => 1
  972. * [-flags] => [channel_flag_semi_permanent] => 0
  973. * [-voice] => [channel_codec] => 2
  974. * [-voice] => [channel_codec_quality] => 7
  975. * [-voice] => [channel_needed_talk_power] => 0
  976. * [-limits] => [total_clients_family] => 1
  977. * [-limits] => [channel_maxclients] => -1
  978. * [-limits] => [channel_maxfamilyclients] => -1
  979. * [-icon] => [channel_icon_id] => 0
  980. * }
  981. * </code><br>
  982. * <b>Usage:</b>
  983. * <code>
  984. * $ts3->channelList(); //No parameters
  985. * $ts3->channelList("-flags"); //Single parameter
  986. * $ts3->channelList("-topic -flags -voice -limits -icon"); //Multiple parameters / all
  987. * </code><br>
  988. *
  989. * @author Par0noid Solutions
  990. * @access public
  991. * @param string $params additional parameters [optional]
  992. * @return array channelList
  993. */
  994. function channelList($params = null) {
  995. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  996. if(!empty($params)) { $params = ' '.$params; }
  998. return $this->getData('multi', 'channellist'.$params);
  999. }
  1001. /**
  1002. * channelMove
  1003. *
  1004. * Moves a channel to a new parent channel with the ID cpid. If order is specified, the channel will be sorted right under the channel with the specified ID. If order is set to 0, the channel will be sorted right below the new parent.
  1005. *
  1006. * @author Par0noid Solutions
  1007. * @access public
  1008. * @param integer $cid channelID
  1009. * @param integer $cpid channelParentID
  1010. * @param integer $order channelSortOrder
  1011. * @return boolean success
  1012. */
  1013. function channelMove($cid, $cpid, $order = null) {
  1014. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1015. return $this->getData('boolean', 'channelmove cid='.$cid.' cpid='.$cpid.($order != null ? ' order='.$order : ''));
  1016. }
  1018. /**
  1019. * channelPermList
  1020. *
  1021. * Displays a list of permissions defined for a channel.
  1022. *
  1023. * <b>Output:</b>
  1024. * <code>
  1025. * Array
  1026. * {
  1027. * [cid] => 2 (only in first result)
  1028. * [permid] => 8471 (if permsid = false)
  1029. * [permsid] => i_channel_needed_delete_power (if permsid = true)
  1030. * [permvalue] => 1
  1031. * [permnegated] => 0
  1032. * [permskip] => 0
  1033. * }
  1034. * </code>
  1035. *
  1036. * @author Par0noid Solutions
  1037. * @access public
  1038. * @param integer $cid channelID
  1039. * @param boolean $permsid displays permissionName instead of permissionID [optional]
  1040. * @return array channelpermlist
  1041. */
  1042. function channelPermList($cid, $permsid = false) {
  1043. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1044. return $this->getData('multi', 'channelpermlist cid='.$cid.($permsid ? ' -permsid' : ''));
  1045. }
  1047. /**
  1048. * clientAddPerm
  1049. *
  1050. * Adds a set of specified permissions to a client. Multiple permissions can be added by providing the three parameters of each permission. A permission can be specified by permid or permsid.
  1051. *
  1052. * <b>Input-Array like this:</b>
  1053. * <code>
  1054. * $permissions = array();
  1055. * $permissions['permissionID'] = array('permissionValue', 'permskip');
  1056. * //or you could use Permission Name
  1057. * $permissions['permissionName'] = array('permissionValue', 'permskip');
  1058. * </code>
  1059. *
  1060. * @author Par0noid Solutions
  1061. * @access public
  1062. * @param integer $cldbid clientDBID
  1063. * @param array $permissions permissions
  1064. * @return boolean success
  1065. */
  1066. function clientAddPerm($cldbid, $permissions) {
  1067. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1069. if(count($permissions) > 0) {
  1070. //Permissions given
  1072. //Errorcollector
  1073. $errors = array();
  1075. //Split Permissions to prevent query from overload
  1076. $permissions = array_chunk($permissions, 50, true);
  1078. //Action for each splitted part of permission
  1079. foreach($permissions as $permission_part)
  1080. {
  1081. //Create command_string for each command that we could use implode later
  1082. $command_string = array();
  1084. foreach($permission_part as $key => $value)
  1085. {
  1086. $command_string[] = (is_numeric($key) ? "permid=" : "permsid=").$this->escapeText($key).' permvalue='.$this->escapeText($value[0]).' permskip='.$this->escapeText($value[1]);
  1087. }
  1089. $result = $this->getData('boolean', 'clientaddperm cldbid='.$cldbid.' '.implode('|', $command_string));
  1091. if(!$result['success'])
  1092. {
  1093. foreach($result['errors'] as $error)
  1094. {
  1095. $errors[] = $error;
  1096. }
  1097. }
  1098. }
  1100. if(count($errors) == 0)
  1101. {
  1102. return $this->generateOutput(true, array(), true);
  1103. }else{
  1104. return $this->generateOutput(false, $errors, false);
  1105. }
  1106. }else{
  1107. // No permissions given
  1108. $this->addDebugLog('no permissions given');
  1109. return $this->generateOutput(false, array('Error: no permissions given'), false);
  1110. }
  1111. }
  1113. /**
  1114. * clientDbDelete
  1115. *
  1116. * Deletes a clients properties from the database.
  1117. *
  1118. * @author Par0noid Solutions
  1119. * @access public
  1120. * @param integer $cldbid clientDBID
  1121. * @return boolean success
  1122. */
  1123. function clientDbDelete($cldbid) {
  1124. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1125. return $this->getData('boolean', 'clientdbdelete cldbid='.$cldbid);
  1126. }
  1128. /**
  1129. * clientDbEdit
  1130. *
  1131. * Changes a clients settings using given properties.
  1132. *
  1133. * <b>Input-Array like this:</b><br>
  1134. * <br><code>
  1135. * $data = array();
  1136. *
  1137. * $data['property'] = 'value';
  1138. * $data['property'] = 'value';
  1139. * </code>
  1140. *
  1141. * @author Par0noid Solutions
  1142. * @access public
  1143. * @param integer $cldbid clientDBID
  1144. * @param array $data clientProperties
  1145. * @return boolean success
  1146. */
  1147. function clientDbEdit($cldbid, $data) {
  1148. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1150. $settingsString = '';
  1152. foreach($data as $key => $value) {
  1153. $settingsString .= ' '.$key.'='.$this->escapeText($value);
  1154. }
  1156. return $this->getData('boolean', 'clientdbedit cldbid='.$cldbid.$settingsString);
  1157. }
  1159. /**
  1160. * clientDbFind
  1161. *
  1162. * Displays a list of client database IDs matching a given pattern. You can either search for a clients last known nickname or his unique identity by using the -uid option.
  1163. *
  1164. * <b>Output:</b><br>
  1165. * <code>
  1166. * Array
  1167. * {
  1168. * [cldbid] => 2
  1169. * }
  1170. * </code>
  1171. *
  1172. * @author Par0noid Solutions
  1173. * @access public
  1174. * @param string $pattern clientName
  1175. * @param boolean $uid set true to add -uid param [optional]
  1176. * @return array clientList
  1177. */
  1178. function clientDbFind($pattern, $uid = false) {
  1179. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1180. return $this->getData('multi', 'clientdbfind pattern='.$this->escapeText($pattern).($uid ? ' -uid' : ''));
  1181. }
  1183. /**
  1184. * clientDbInfo
  1185. *
  1186. * Displays detailed database information about a client including unique ID, creation date, etc.
  1187. *
  1188. * <b>Output:</b>
  1189. * <code>
  1190. * Array
  1191. * {
  1192. * [client_unique_identifier] => nUixbsq/XakrrmbqU8O30R/D8Gc=
  1193. * [client_nickname] => par0noid
  1194. * [client_database_id] => 2
  1195. * [client_created] => 1361027850
  1196. * [client_lastconnected] => 1361027850
  1197. * [client_totalconnections] => 1
  1198. * [client_flag_avatar] =>
  1199. * [client_description] =>
  1200. * [client_month_bytes_uploaded] => 0
  1201. * [client_month_bytes_downloaded] => 0
  1202. * [client_total_bytes_uploaded] => 0
  1203. * [client_total_bytes_downloaded] => 0
  1204. * [client_icon_id] => 0
  1205. * [client_base64HashClientUID] => jneilbgomklpfnkjclkoggokfdmdlhnbbpmdpagh
  1206. * [client_lastip] => 127.0.0.1
  1207. * }
  1208. * </code>
  1209. *
  1210. * @author Par0noid Solutions
  1211. * @access public
  1212. * @param integer $cldbid clientDBID
  1213. * @return array clientDbInfo
  1214. */
  1215. function clientDbInfo($cldbid) {
  1216. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1217. return $this->getData('array', 'clientdbinfo cldbid='.$cldbid);
  1218. }
  1220. /**
  1221. * clientDbList
  1222. *
  1223. * Displays a list of client identities known by the server including their database ID, last nickname, etc.
  1224. *
  1225. * <br><b>Possible params:</b> [start={offset}] [duration={limit}] [-count]<br><br>
  1226. *
  1227. * <b>Output:</b>
  1228. * <code>
  1229. * Array
  1230. * {
  1231. * [count] => 1 (if count parameter is set)
  1232. * [cldbid] => 2
  1233. * [client_unique_identifier] => nUixbsq/XakrrmbqU8O30R/D8Gc=
  1234. * [client_nickname] => par0noid
  1235. * [client_created] => 1361027850
  1236. * [client_lastconnected] => 1361027850
  1237. * [client_totalconnections] => 1
  1238. * [client_description] =>
  1239. * [client_lastip] => 127.0.0.1
  1240. * }
  1241. * </code>
  1242. *
  1243. * @author Par0noid Solutions
  1244. * @access public
  1245. * @param integer $start offset [optional] (Default: 0)
  1246. * @param integer $duration limit [optional] (Default: -1)
  1247. * @param boolean $count set true to add -count param [optional]
  1248. * @return array clientdblist
  1249. */
  1250. function clientDbList($start = 0, $duration = -1, $count = false) {
  1251. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1252. return $this->getData('multi', 'clientdblist start='.$start.' duration='.$duration.($count ? ' -count' : ''));
  1253. }
  1255. /**
  1256. * clientDelPerm
  1257. *
  1258. * Removes a set of specified permissions from a client. Multiple permissions can be removed at once. A permission can be specified by permid or permsid.
  1259. *
  1260. * <b>Input-Array like this:</b>
  1261. * <code>
  1262. * $permissions = array();
  1263. * $permissions['permissionID'] = 'permissionValue';
  1264. * //or you could use Permission Name
  1265. * $permissions['permissionName'] = 'permissionValue';
  1266. * </code>
  1267. *
  1268. * @author Par0noid Solutions
  1269. * @access public
  1270. * @param integer $cldbid clientDBID
  1271. * @param array $permissionIds permissionIDs
  1272. * @return boolean success
  1273. */
  1274. function clientDelPerm($cldbid, $permissionIds) {
  1275. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1277. $permissionArray = array();
  1279. if(count($permissionIds) > 0) {
  1280. foreach($permissionIds AS $value) {
  1281. $permissionArray[] = (is_numeric($value) ? 'permid=' : 'permsid=').$value;
  1282. }
  1283. return $this->getData('boolean', 'clientdelperm cldbid='.$cldbid.' '.implode('|', $permissionArray));
  1284. }else{
  1285. $this->addDebugLog('no permissions given');
  1286. return $this->generateOutput(false, array('Error: no permissions given'), false);
  1287. }
  1288. }
  1290. /**
  1291. * clientEdit
  1292. *
  1293. * Changes a clients settings using given properties.
  1294. *
  1295. * <b>Input-Array like this:</b>
  1296. * <code>
  1297. * $data = array();
  1298. *
  1299. * $data['property'] = 'value';
  1300. * $data['property'] = 'value';
  1301. * </code>
  1302. *
  1303. * @author Par0noid Solutions
  1304. * @access public
  1305. * @param integer $clid clientID
  1306. * @param array $data clientProperties
  1307. * @return boolean success
  1308. */
  1309. function clientEdit($clid, $data) {
  1310. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1312. $settingsString = '';
  1314. foreach($data as $key => $value) {
  1315. $settingsString .= ' '.$key.'='.$this->escapeText($value);
  1316. }
  1318. return $this->getData('boolean', 'clientedit clid='.$clid.$settingsString);
  1319. }
  1321. /**
  1322. * clientFind
  1323. *
  1324. * Displays a list of clients matching a given name pattern.
  1325. *
  1326. * <b>Output:</b>
  1327. * <code>
  1328. * Array
  1329. * {
  1330. * [clid] => 18
  1331. * [client_nickname] => par0noid
  1332. * }
  1333. * </code>
  1334. *
  1335. * @author Par0noid Solutions
  1336. * @access public
  1337. * @param string $pattern clientName
  1338. * @return array clienList
  1339. */
  1340. function clientFind($pattern) {
  1341. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1342. return $this->getData('multi', 'clientfind pattern='.$this->escapeText($pattern));
  1343. }
  1345. /**
  1346. * clientGetDbIdFromUid
  1347. *
  1348. * Displays the database ID matching the unique identifier specified by cluid.
  1349. *
  1350. * <b>Output:</b>
  1351. * <code>
  1352. * Array
  1353. * {
  1354. * [cluid] => nUixbsq/XakrrmbqU8O30R/D8Gc=
  1355. * [cldbid] => 2
  1356. * }
  1357. * </code>
  1358. *
  1359. * @author Par0noid Solutions
  1360. * @access public
  1361. * @param string $cluid clientUID
  1362. * @return array clientInfo
  1363. */
  1364. function clientGetDbIdFromUid($cluid) {
  1365. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1366. return $this->getData('array', 'clientgetdbidfromuid cluid='.$cluid);
  1367. }
  1369. /**
  1370. * clientGetIds
  1371. *
  1372. * Displays all client IDs matching the unique identifier specified by cluid.
  1373. *
  1374. * <b>Output:</b>
  1375. * <code>
  1376. * Array
  1377. * {
  1378. * [cluid] => nUixbdf/XakrrmsdffO30R/D8Gc=
  1379. * [clid] => 7
  1380. * [name] => Par0noid
  1381. * }
  1382. * </code>
  1383. *
  1384. * @author Par0noid Solutions
  1385. * @access public
  1386. * @param string $cluid clientUID
  1387. * @return array clientList
  1388. */
  1389. function clientGetIds($cluid) {
  1390. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1391. return $this->getData('multi', 'clientgetids cluid='.$cluid);
  1392. }
  1394. /**
  1395. * clientGetNameFromDbid
  1396. *
  1397. * Displays the unique identifier and nickname matching the database ID specified by cldbid.
  1398. *
  1399. * <b>Output:</b>
  1400. * <code>
  1401. * Array
  1402. * {
  1403. * [cluid] => nUixbsq/XakrrmbqU8O30R/D8Gc=
  1404. * [cldbid] => 2
  1405. * [name] => Par0noid
  1406. * }
  1407. * </code>
  1408. *
  1409. * @author Par0noid Solutions
  1410. * @access public
  1411. * @param integer $cldbid clientDBID
  1412. * @return array clientInfo
  1413. */
  1414. function clientGetNameFromDbid($cldbid) {
  1415. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1416. return $this->getData('array', 'clientgetnamefromdbid cldbid='.$cldbid);
  1417. }
  1419. /**
  1420. * clientGetNameFromUid
  1421. *
  1422. * Displays the database ID and nickname matching the unique identifier specified by cluid.
  1423. *
  1424. * <b>Output:</b>
  1425. * <code>
  1426. * Array
  1427. * {
  1428. * [cluid] => nUixbsq/XakrrmbqU8O30R/D8Gc=
  1429. * [cldbid] => 2
  1430. * [name] => Par0noid
  1431. * }
  1432. * </code>
  1433. *
  1434. * @author Par0noid Solutions
  1435. * @access public
  1436. * @param string $cluid clientUID
  1437. * @return array clientInfo
  1438. */
  1439. function clientGetNameFromUid($cluid) {
  1440. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1441. return $this->getData('array', 'clientgetnamefromuid cluid='.$cluid);
  1442. }
  1444. /**
  1445. * clientInfo
  1446. *
  1447. * Displays detailed configuration information about a client including unique ID, nickname, client version, etc.
  1448. *
  1449. * <b>Output:</b>
  1450. * <code>
  1451. * Array
  1452. * {
  1453. * [cid] => 2
  1454. * [client_idle_time] => 4445369
  1455. * [client_unique_identifier] => nUixbsq/XakrrmbqU8O30R/D8Gc=
  1456. * [client_nickname] => par0noid
  1457. * [client_version] => 3.0.9.2 [Build: 1351504843]
  1458. * [client_platform] => Windows
  1459. * [client_input_muted] => 1
  1460. * [client_output_muted] => 1
  1461. * [client_outputonly_muted] => 0
  1462. * [client_input_hardware] => 1
  1463. * [client_output_hardware] => 1
  1464. * [client_default_channel] =>
  1465. * [client_meta_data] =>
  1466. * [client_is_recording] => 0
  1467. * [client_login_name] =>
  1468. * [client_database_id] => 2
  1469. * [client_channel_group_id] => 5
  1470. * [client_servergroups] => 6
  1471. * [client_created] => 1361027850
  1472. * [client_lastconnected] => 1361027850
  1473. * [client_totalconnections] => 1
  1474. * [client_away] => 0
  1475. * [client_away_message] =>
  1476. * [client_type] => 0
  1477. * [client_flag_avatar] =>
  1478. * [client_talk_power] => 75
  1479. * [client_talk_request] => 0
  1480. * [client_talk_request_msg] =>
  1481. * [client_description] =>
  1482. * [client_is_talker] => 0
  1483. * [client_month_bytes_uploaded] => 0
  1484. * [client_month_bytes_downloaded] => 0
  1485. * [client_total_bytes_uploaded] => 0
  1486. * [client_total_bytes_downloaded] => 0
  1487. * [client_is_priority_speaker] => 0
  1488. * [client_nickname_phonetic] =>
  1489. * [client_needed_serverquery_view_power] => 75
  1490. * [client_default_token] =>
  1491. * [client_icon_id] => 0
  1492. * [client_is_channel_commander] => 0
  1493. * [client_country] =>
  1494. * [client_channel_group_inherited_channel_id] => 2
  1495. * [client_base64HashClientUID] => jneilbgomklpfnkjclkoggokfdmdlhnbbpmdpagh
  1496. * [connection_filetransfer_bandwidth_sent] => 0
  1497. * [connection_filetransfer_bandwidth_received] => 0
  1498. * [connection_packets_sent_total] => 12130
  1499. * [connection_bytes_sent_total] => 542353
  1500. * [connection_packets_received_total] => 12681
  1501. * [connection_bytes_received_total] => 592935
  1502. * [connection_bandwidth_sent_last_second_total] => 82
  1503. * [connection_bandwidth_sent_last_minute_total] => 92
  1504. * [connection_bandwidth_received_last_second_total] => 84
  1505. * [connection_bandwidth_received_last_minute_total] => 88
  1506. * [connection_connected_time] => 5908749
  1507. * [connection_client_ip] => 127.0.0.1
  1508. * }
  1509. * </code>
  1510. *
  1511. * @author Par0noid Solutions
  1512. * @access public
  1513. * @param integer $clid clientID
  1514. * @return array clientInformation
  1515. */
  1516. function clientInfo($clid) {
  1517. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1518. return $this->getData('array', 'clientinfo clid='.$clid);
  1519. }
  1521. /**
  1522. * clientKick
  1523. *
  1524. * Kicks one or more clients specified with clid from their currently joined channel or from the server, depending on reasonid. The reasonmsg parameter specifies a text message sent to the kicked clients. This parameter is optional and may only have a maximum of 40 characters.
  1525. *
  1526. * @author Par0noid Solutions
  1527. * @access public
  1528. * @param integer $clid clientID
  1529. * @param string $kickMode kickMode (server or channel) (Default: servera)
  1530. * @param string $kickmsg kick reason [optional]
  1531. * @return boolean success
  1532. */
  1533. function clientKick($clid, $kickMode = "server", $kickmsg = "") {
  1534. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1536. if(in_array($kickMode, array('server', 'channel'))) {
  1538. if($kickMode == 'server') { $from = '5'; }
  1539. if($kickMode == 'channel') { $from = '4'; }
  1541. if(!empty($kickmsg)) { $msg = ' reasonmsg='.$this->escapeText($kickmsg); } else{ $msg = ''; }
  1543. return $this->getData('boolean', 'clientkick clid='.$clid.' reasonid='.$from.$msg);
  1544. }else{
  1545. $this->addDebugLog('invalid kickMode');
  1546. return $this->generateOutput(false, array('Error: invalid kickMode'), false);
  1547. }
  1548. }
  1550. /**
  1551. * clientList
  1552. *
  1553. * Displays a list of clients online on a virtual server including their ID, nickname, status flags, etc. The output can be modified using several command options. Please note that the output will only contain clients which are currently in channels you're able to subscribe to.
  1554. *
  1555. * <br><b>Possible params:</b> [-uid] [-away] [-voice] [-times] [-groups] [-info] [-icon] [-country] [-ip] [-badges]<br><br>
  1556. *
  1557. * <b>Output: (without parameters)</b>
  1558. * <code>
  1559. * Array
  1560. * {
  1561. * [clid] => 1
  1562. * [cid] => 1
  1563. * [client_database_id] => 2
  1564. * [client_nickname] => Par0noid
  1565. * [client_type] => 0
  1566. * [-uid] => [client_unique_identifier] => nUixbsq/XakrrmbqU8O30R/D8Gc=
  1567. * [-away] => [client_away] => 0
  1568. * [-away] => [client_away_message] =>
  1569. * [-voice] => [client_flag_talking] => 0
  1570. * [-voice] => [client_input_muted] => 0
  1571. * [-voice] => [client_output_muted] => 0
  1572. * [-voice] => [client_input_hardware] => 0
  1573. * [-voice] => [client_output_hardware] => 0
  1574. * [-voice] => [client_talk_power] => 0
  1575. * [-voice] => [client_is_talker] => 0
  1576. * [-voice] => [client_is_priority_speaker] => 0
  1577. * [-voice] => [client_is_recording] => 0
  1578. * [-voice] => [client_is_channel_commander] => 0
  1579. * [-times] => [client_idle_time] => 1714
  1580. * [-times] => [client_created] => 1361027850
  1581. * [-times] => [client_lastconnected] => 1361042955
  1582. * [-groups] => [client_servergroups] => 6,7
  1583. * [-groups] => [client_channel_group_id] => 8
  1584. * [-groups] => [client_channel_group_inherited_channel_id] => 1
  1585. * [-info] => [client_version] => 3.0.9.2 [Build: 1351504843]
  1586. * [-info] => [client_platform] => Windows
  1587. * [-icon] => [client_icon_id] => 0
  1588. * [-country] => [client_country] =>
  1589. * [-ip] => [connection_client_ip] => 127.0.0.1
  1590. * [-badges] => [client_badges] => Overwolf=0
  1591. * }
  1592. * </code><br>
  1593. * <b>Usage:</b>
  1594. * <code>
  1595. * $ts3->clientList(); //No parameters
  1596. * $ts3->clientList("-uid"); //Single parameter
  1597. * $ts3->clientList("-uid -away -voice -times -groups -info -country -icon -ip -badges"); //Multiple parameters
  1598. * </code><br>
  1599. *
  1600. * @author Par0noid Solutions
  1601. * @access public
  1602. * @param string $params additional parameters [optional]
  1603. * @return array clientList
  1604. */
  1605. function clientList($params = null) {
  1606. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1608. if(!empty($params)) { $params = ' '.$params; }
  1610. return $this->getData('multi', 'clientlist'.$params);
  1611. }
  1613. /**
  1614. * clientMove
  1615. *
  1616. * Moves one or more clients specified with clid to the channel with ID cid. If the target channel has a password, it needs to be specified with cpw. If the channel has no password, the parameter can be omitted.
  1617. *
  1618. * @author Par0noid Solutions
  1619. * @access public
  1620. * @param integer $clid clientID
  1621. * @param integer $cid channelID
  1622. * @param string $cpw channelPassword [optional]
  1623. * @return boolean success
  1624. */
  1625. function clientMove($clid, $cid, $cpw = null) {
  1626. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1627. return $this->getData('boolean', 'clientmove clid='.$clid.' cid='.$cid.(!empty($cpw) ? ' cpw='.$this->escapeText($cpw) : ''));
  1628. }
  1630. /**
  1631. * clientPermList
  1632. *
  1633. * Displays a list of permissions defined for a client.
  1634. *
  1635. * <b>Output:</b>
  1636. * <code>
  1637. * Array
  1638. * {
  1639. * [permid] => 20654 //with permsid = false
  1640. * [permsid] => b_client_ignore_bans //with permsid = true
  1641. * [permvalue] => 1
  1642. * [permnegated] => 0
  1643. * [permskip] => 0
  1644. * }
  1645. * </code>
  1646. *
  1647. * @author Par0noid Solutions
  1648. * @access public
  1649. * @param intege $cldbid clientDBID
  1650. * @param boolean $permsid set true to add -permsid param [optional]
  1651. * @return array clientPermList
  1652. */
  1653. function clientPermList($cldbid, $permsid = false) {
  1654. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1655. return $this->getData('multi', 'clientpermlist cldbid='.$cldbid.($permsid ? ' -permsid' : ''));
  1656. }
  1658. /**
  1659. * clientPoke
  1660. *
  1661. * Sends a poke message to the client specified with clid.
  1662. *
  1663. * @author Par0noid Solutions
  1664. * @access public
  1665. * @param integer $clid clientID
  1666. * @param string $msg pokeMessage
  1667. * @return boolean success
  1668. */
  1669. function clientPoke($clid, $msg) {
  1670. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1671. return $this->getData('boolean', 'clientpoke clid='.$clid.' msg='.$this->escapeText($msg));
  1672. }
  1674. /**
  1675. * clientSetServerQueryLogin
  1676. *
  1677. * Updates your own ServerQuery login credentials using a specified username. The password will be auto-generated.
  1678. *
  1679. * <b>Output:</b>
  1680. * <code>
  1681. * Array
  1682. * {
  1683. * [client_login_password] => +r\/TQqvR
  1684. * }
  1685. * </code>
  1686. *
  1687. * @author Par0noid Solutions
  1688. * @access public
  1689. * @param string $username username
  1690. * @return array userInfomation
  1691. */
  1692. function clientSetServerQueryLogin($username) {
  1693. return $this->getData('array', 'clientsetserverquerylogin client_login_name='.$this->escapeText($username));
  1694. }
  1696. /**
  1697. * clientUpdate
  1698. *
  1699. * Change your ServerQuery clients settings using given properties.
  1700. *
  1701. * <b>Input-Array like this:</b>
  1702. * <code>
  1703. * $data = array();
  1704. * $data['property'] = 'value';
  1705. * $data['property'] = 'value';
  1706. * </code>
  1707. *
  1708. * @author Par0noid Solutions
  1709. * @access public
  1710. * @param array $data clientProperties
  1711. * @return boolean success
  1712. */
  1713. function clientUpdate($data) {
  1714. $settingsString = '';
  1716. foreach($data as $key => $value) {
  1717. $settingsString .= ' '.$key.'='.$this->escapeText($value);
  1718. }
  1720. return $this->getData('boolean', 'clientupdate '.$settingsString);
  1721. }
  1723. /**
  1724. * complainAdd
  1725. *
  1726. * Submits a complaint about the client with database ID tcldbid to the server.
  1727. *
  1728. * @author Par0noid Solutions
  1729. * @access public
  1730. * @param integer $tcldbid targetClientDBID
  1731. * @param string $msg complainMessage
  1732. * @return boolean success
  1733. */
  1734. function complainAdd($tcldbid, $msg) {
  1735. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1736. return $this->getData('boolean', 'complainadd tcldbid='.$tcldbid.' message='.$this->escapeText($msg));
  1737. }
  1739. /**
  1740. * complainDelete
  1741. *
  1742. * Deletes the complaint about the client with ID tcldbid submitted by the client with ID fcldbid from the server.
  1743. *
  1744. * @author Par0noid Solutions
  1745. * @access public
  1746. * @param integer $tcldbid targetClientDBID
  1747. * @param integer $fcldbid fromClientDBID
  1748. * @return boolean success
  1749. */
  1750. function complainDelete($tcldbid, $fcldbid) {
  1751. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1752. return $this->getData('boolean', 'complaindel tcldbid='.$tcldbid.' fcldbid='.$fcldbid);
  1753. }
  1755. /**
  1756. * complainDeleteAll
  1757. *
  1758. * Deletes all complaints about the client with database ID tcldbid from the server.
  1759. *
  1760. * @author Par0noid Solutions
  1761. * @access public
  1762. * @param integer $tcldbid targetClientDBID
  1763. * @return boolean success
  1764. */
  1765. function complainDeleteAll($tcldbid) {
  1766. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1767. return $this->getData('boolean', 'complaindelall tcldbid='.$tcldbid);
  1768. }
  1770. /**
  1771. * complainList
  1772. *
  1773. * Displays a list of complaints on the selected virtual server. If tcldbid is specified, only complaints about the targeted client will be shown.
  1774. *
  1775. * <b>Output:</b>
  1776. * <code>
  1777. * Array
  1778. * {
  1779. * [tcldbid] => 2
  1780. * [tname] => par0noid
  1781. * [fcldbid] => 1
  1782. * [fname] => serveradmin from 127.0.0.1:6814
  1783. * [message] => Steals crayons
  1784. * [timestamp] => 1361044090
  1785. * }
  1786. * </code>
  1787. *
  1788. * @author Par0noid Solutions
  1789. * @access public
  1790. * @param string $tcldbid targetClientDBID [optional]
  1791. * @return array complainList
  1792. */
  1793. function complainList($tcldbid = null) {
  1794. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1795. if(!empty($tcldbid)) { $tcldbid = ' tcldbid='.$tcldbid; }
  1796. return $this->getData('multi', 'complainlist'.$tcldbid);
  1797. }
  1799. /**
  1800. * execOwnCommand
  1801. *
  1802. * executes a command that isn't defined in class and returns data like your propose
  1803. *
  1804. * <b>Modes:</b>
  1805. * <ul>
  1806. * <li><b>0:</b> execute -> return boolean</li>
  1807. * <li><b>1:</b> execute -> return normal array</li>
  1808. * <li><b>2:</b> execute -> return multidimensional array</li>
  1809. * <li><b>3:</b> execute -> return plaintext serverquery</li>
  1810. * </ul>
  1811. *
  1812. * @author Par0noid Solutions
  1813. * @access public
  1814. * @param string $mode executionMode
  1815. * @param string $command command
  1816. * @return mixed result
  1817. */
  1818. function execOwnCommand($mode, $command) {
  1819. if($mode == '0') {
  1820. return $this->getData('boolean', $command);
  1821. }
  1822. if($mode == '1') {
  1823. return $this->getData('array', $command);
  1824. }
  1825. if($mode == '2') {
  1826. return $this->getData('multi', $command);
  1827. }
  1828. if($mode == '3') {
  1829. return $this->getData('plain', $command);
  1830. }
  1831. }
  1833. /**
  1834. * ftCreateDir
  1835. *
  1836. * Creates new directory in a channels file repository.
  1837. *
  1838. * @author Par0noid Solutions
  1839. * @access public
  1840. * @param string $cid channelId
  1841. * @param string $cpw channelPassword (leave blank if not needed)
  1842. * @param string $dirname dirPath
  1843. * @return boolean success
  1844. */
  1845. function ftCreateDir($cid, $cpw = null, $dirname) {
  1846. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1847. return $this->getData('boolean', 'ftcreatedir cid='.$cid.' cpw='.$this->escapeText($cpw).' dirname='.$this->escapeText($dirname));
  1848. }
  1850. /**
  1851. * ftDeleteFile
  1852. *
  1853. * Deletes one or more files stored in a channels file repository.
  1854. *
  1855. * <b>Input-Array like this:</b>
  1856. * <code>
  1857. * $files = array();
  1858. *
  1859. * $files[] = '/pic1.jpg';
  1860. * $files[] = '/dokumente/test.txt';
  1861. * $files[] = '/dokumente';
  1862. * </code>
  1863. *
  1864. * @author Par0noid Solutions
  1865. * @access public
  1866. * @param string $cid channelID
  1867. * @param string $cpw channelPassword (leave blank if not needed)
  1868. * @param array $files files
  1869. * @return boolean success
  1870. */
  1871. function ftDeleteFile($cid, $cpw = '', $files) {
  1872. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1873. $fileArray = array();
  1875. if(count($files) > 0) {
  1876. foreach($files AS $file) {
  1877. $fileArray[] = 'name='.$this->escapeText($file);
  1878. }
  1879. return $this->getData('boolean', 'ftdeletefile cid='.$cid.' cpw='.$this->escapeText($cpw).' '.implode('|', $fileArray));
  1880. }else{
  1881. $this->addDebugLog('no files given');
  1882. return $this->generateOutput(false, array('Error: no files given'), false);
  1883. }
  1884. }
  1886. /**
  1887. * ftDownloadFile
  1888. *
  1889. * Ddownloads a file and returns its contents
  1890. *
  1891. * @author Par0noid Solutions
  1892. * @access public
  1893. * @param array $data return of ftInitDownload
  1894. * @return array downloadedFile
  1895. */
  1896. function ftDownloadFile($data) {
  1897. $this->runtime['fileSocket'] = @fsockopen($this->runtime['host'], $data['data']['port'], $errnum, $errstr, $this->runtime['timeout']);
  1898. if($this->runtime['fileSocket']) {
  1899. $this->ftSendKey($data['data']['ftkey']);
  1900. $content = $this->ftRead($data['data']['size']);
  1901. @fclose($this->runtime['fileSocket']);
  1902. $this->runtime['fileSocket'] = '';
  1903. return $content;
  1904. }else{
  1905. $this->addDebugLog('fileSocket returns '.$errnum. ' | '.$errstr);
  1906. return $this->generateOutput(false, array('Error in fileSocket: '.$errnum. ' | '.$errstr), false);
  1907. }
  1908. }
  1910. /**
  1911. * ftGetFileInfo
  1912. *
  1913. * Displays detailed information about one or more specified files stored in a channels file repository.
  1914. *
  1915. * <b>Input-Array like this:</b>
  1916. * <code>
  1917. * $files = array();
  1918. *
  1919. * $files[] = '/pic1.jpg';
  1920. * $files[] = '/dokumente/test.txt';
  1921. * $files[] = '/dokumente';
  1922. * </code><br>
  1923. * <b>Output:</b>
  1924. * <code>
  1925. * Array
  1926. * {
  1927. * [cid] => 231
  1928. * [name] => /dfsdfsdf.txt
  1929. * [size] => 1412
  1930. * [datetime] => 1286634258
  1931. * }
  1932. * </code>
  1933. *
  1934. *
  1935. * @author Par0noid Solutions
  1936. * @access public
  1937. * @param string $cid channelID
  1938. * @param string $cpw channelPassword (leave blank if not needed)
  1939. * @param array $files files
  1940. * @return boolean success
  1941. */
  1942. function ftGetFileInfo($cid, $cpw = '', $files) {
  1943. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1944. $fileArray = array();
  1946. if(count($files) > 0) {
  1947. foreach($files AS $file) {
  1948. $fileArray[] = 'name='.$this->escapeText($file);
  1949. }
  1950. return $this->getData('multi', 'ftgetfileinfo cid='.$cid.' cpw='.$this->escapeText($cpw).' '.implode('|', $fileArray));
  1951. }else{
  1952. $this->addDebugLog('no files given');
  1953. return $this->generateOutput(false, array('Error: no files given'), false);
  1954. }
  1955. }
  1957. /**
  1958. * ftGetFileList
  1959. *
  1960. * Displays a list of files and directories stored in the specified channels file repository.
  1961. *
  1962. * <b>Output:</b>
  1963. * <code>
  1964. * Array
  1965. * {
  1966. * [cid] => 231
  1967. * [path] => /
  1968. * [name] => Documents
  1969. * [size] => 0
  1970. * [datetime] => 1286633633
  1971. * [type] => 0
  1972. * }
  1973. * </code>
  1974. *
  1975. * @author Par0noid Solutions
  1976. * @access public
  1977. * @param string $cid channelID
  1978. * @param string $cpw channelPassword (leave blank if not needed)
  1979. * @param string $path filePath
  1980. * @return array fileList
  1981. */
  1982. function ftGetFileList($cid, $cpw = '', $path) {
  1983. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  1984. return $this->getData('multi', 'ftgetfilelist cid='.$cid.' cpw='.$this->escapeText($cpw).' path='.$this->escapeText($path));
  1985. }
  1987. /**
  1988. * ftInitDownload
  1989. *
  1990. * Initializes a file transfer download. clientftfid is an arbitrary ID to identify the file transfer on client-side. On success, the server generates a new ftkey which is required to start downloading the file through TeamSpeak 3's file transfer interface.
  1991. *
  1992. * <b>Output:</b>
  1993. * <code>
  1994. * Array
  1995. * {
  1996. * [clientftfid] => 89
  1997. * [serverftfid] => 3
  1998. * [ftkey] => jSzWiRmFGdZnoJzW7BSDYJRUWB2WAUhb
  1999. * [port] => 30033
  2000. * [size] => 94
  2001. * }
  2002. * </code>
  2003. *
  2004. * @author Par0noid Solutions
  2005. * @access public
  2006. * @param string $name filePath
  2007. * @param string $cid channelID
  2008. * @param string $cpw channelPassword (leave blank if not needed)
  2009. * @param integer $seekpos seekpos (default = 0) [optional]
  2010. * @return array initDownloadFileInfo
  2011. */
  2012. function ftInitDownload($name, $cid, $cpw = '', $seekpos = 0) {
  2013. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  2014. return $this->getData('array', 'ftinitdownload clientftfid='.rand(1,99).' name='.$this->escapeText($name).' cid='.$cid.' cpw='.$this->escapeText($cpw).' seekpos='.$seekpos);
  2015. }
  2017. /**
  2018. * ftInitUpload
  2019. *
  2020. * Initializes a file transfer upload. clientftfid is an arbitrary ID to identify the file transfer on client-side. On success, the server generates a new ftkey which is required to start uploading the file through TeamSpeak 3's file transfer interface.
  2021. *
  2022. * <b>Output:</b>
  2023. * <code>
  2024. * Array
  2025. * {
  2026. * [clientftfid] => 84
  2027. * [serverftfid] => 41
  2028. * [ftkey] => HCnXpunOdAorqj3dGqfiuLszX18O0PHP
  2029. * [port] => 30033
  2030. * [seekpos] => 0
  2031. * }
  2032. * </code>
  2033. *
  2034. * @author Par0noid Solutions
  2035. * @access public
  2036. * @param string $filename filePath
  2037. * @param string $cid channelID
  2038. * @param integer $size fileSize in bytes
  2039. * @param string $cpw channelPassword (leave blank if not needed)
  2040. * @param boolean $overwrite overwrite [optional] (default = 0)
  2041. * @param boolean $resume resume [optional] (default = 0)
  2042. * @return array initUploadFileInfo
  2043. */
  2044. function ftInitUpload($filename, $cid, $size, $cpw = '', $overwrite = false, $resume = false) {
  2045. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  2047. if($overwrite) { $overwrite = ' overwrite=1'; }else{ $overwrite = ' overwrite=0'; }
  2048. if($resume) { $resume = ' resume=1'; }else{ $resume = ' resume=0'; }
  2050. return $this->getData('array', 'ftinitupload clientftfid='.rand(1,99).' name='.$this->escapeText($filename).' cid='.$cid.' cpw='.$this->escapeText($cpw).' size='.($size + 1).$overwrite.$resume);
  2051. }
  2053. /**
  2054. * ftList
  2055. *
  2056. * Displays a list of running file transfers on the selected virtual server. The output contains the path to which a file is uploaded to, the current transfer rate in bytes per second, etc
  2057. *
  2058. * <b>Output:</b>
  2059. * <code>
  2060. * Array
  2061. * {
  2062. * [clid] => 1
  2063. * [cldbid] => 2019
  2064. * [path] => files/virtualserver_11/channel_231
  2065. * [name] => 1285412348878.png
  2066. * [size] => 1161281
  2067. * [sizedone] => 275888
  2068. * [clientftfid] => 15
  2069. * [serverftfid] => 52
  2070. * [sender] => 0
  2071. * [status] => 1
  2072. * [current_speed] => 101037.4453
  2073. * [average_speed] => 101037.4453
  2074. * [runtime] => 2163
  2075. * }
  2076. * </code>
  2077. *
  2078. * @author Par0noid Solutions
  2079. * @access public
  2080. * @return array fileTransferList
  2081. */
  2082. function ftList() {
  2083. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  2084. return $this->getData('multi', 'ftlist');
  2085. }
  2087. /**
  2088. * ftRenameFile
  2089. *
  2090. * Renames a file in a channels file repository. If the two parameters tcid and tcpw are specified, the file will be moved into another channels file repository.
  2091. *
  2092. * @author Par0noid Solutions
  2093. * @access public
  2094. * @param integer $cid channelID
  2095. * @param string $cpw channelPassword (leave blank if not needed)
  2096. * @param string $oldname oldFilePath
  2097. * @param string $newname newFilePath
  2098. * @param string $tcid targetChannelID [optional]
  2099. * @param string $tcpw targetChannelPassword [optional]
  2100. * @return boolean success
  2101. */
  2102. function ftRenameFile($cid, $cpw = null, $oldname, $newname, $tcid = null, $tcpw = null) {
  2103. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  2104. $newTarget = ($tcid != null ? ' tcid='.$tcid.' '.$tcpw : '');
  2105. return $this->getData('boolean', 'ftrenamefile cid='.$cid.' cpw='.$cpw.' oldname='.$this->escapeText($oldname).' newname='.$this->escapeText($newname).$newTarget);
  2106. }
  2108. /**
  2109. * ftStop
  2110. *
  2111. * Stops the running file transfer with server-side ID serverftfid.
  2112. *
  2113. * @author Par0noid Solutions
  2114. * @access public
  2115. * @param integer $serverftfid serverFileTransferID
  2116. * @param boolean $delete delete incomplete file [optional] (default: true)
  2117. * @return boolean success
  2118. */
  2119. function ftStop($serverftfid, $delete = true) {
  2120. if(!$this->runtime['selected']) { return $this->checkSelected(); }
  2121. return $this->getData('boolean', 'ftstop serverftfid='.$serverftfid.' delete='.($delete ? '1' : '0'));
  2122. }
  2124. /**
  2125. * ftUploadFile
  2126. *
  2127. * Uploads a file to server
  2128. * To check if upload was successful, you have to search for this file in fileList after
  2129. *
  2130. * @author Par0noid Solutions
  2131. * @access public
  2132. * @param array $data return of ftInitUpload
  2133. * @param string $uploadData data which should be uploaded
  2134. * @return array response
  2135. */
  2136. ?>
comments powered by Disqus