pluginqueuehandler.php 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. <?php
  2. /*
  3. * StatusNet - the distributed open-source microblogging tool
  4. * Copyright (C) 2008, 2009, StatusNet, Inc.
  5. *
  6. * This program is free software: you can redistribute it and/or modify
  7. * it under the terms of the GNU Affero General Public License as published by
  8. * the Free Software Foundation, either version 3 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU Affero General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Affero General Public License
  17. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  18. */
  19. defined('GNUSOCIAL') || die();
  20. /**
  21. * Queue handler for letting plugins handle stuff.
  22. *
  23. * The plugin queue handler accepts notices over the "plugin" queue
  24. * and simply passes them through the "HandleQueuedNotice" event.
  25. *
  26. * This gives plugins a chance to do background processing without
  27. * actually registering their own queue and ensuring that things
  28. * are queued into it.
  29. *
  30. * Fancier plugins may wish to instead hook the 'GetQueueHandlerClass'
  31. * event with their own class, in which case they must ensure that
  32. * their notices get enqueued when they need them.
  33. */
  34. class PluginQueueHandler extends QueueHandler
  35. {
  36. function transport()
  37. {
  38. return 'plugin';
  39. }
  40. function handle($notice) : bool
  41. {
  42. if (!($notice instanceof Notice)) {
  43. common_log(LOG_ERR, "Got a bogus notice, not broadcasting");
  44. return true;
  45. }
  46. try {
  47. Event::handle('HandleQueuedNotice', array(&$notice));
  48. } catch (NoProfileException $unp) {
  49. // We can't do anything about this, so just skip
  50. return true;
  51. }
  52. return true;
  53. }
  54. }