Plugins Installation Notes

• SiteMinderPlugin overwrites lib/TWiki.pm
  • Someone needs to take ownership of this: I no longer use SiteMinder for authentication and as promised on SiteMinderPluginDev intend to obsolete it. Yet I appreciate that it offers unique functionality. Unless the TWiki.pm hack can be incorporated into a hook this should be reclassified as an AddOnPackage anyway. -- MartinCleaver - 25 Nov 2004
• PeerPlugin causes TWiki to fail (Can't call method "disconnect" on an undefined value at ../lib/TWiki/Plugins/PeerPlugin/Review.pm line 27.)
  • Needs a DB IIRC. -- MartinCleaver - 25 Nov 2004
• Plugins.Notificationplugin causes fail on save (Undefined subroutine &TWiki::formatGmTime called at ../lib/TWiki/Plugins/NotificationPlugin.pm line 234.)
• BatchUploadPlugin doesn't compile: Illegal character in prototype for TWiki::Plugins::BatchUploadPlugin::beforeAttachmentSaveHandler : $attrHashRef,$topic,$web at ../lib/TWiki/Plugins/BatchUploadPlugin.pm line 91.
  • Will check, worked for me before under 5.6.1 -- MartinCleaver - 25 Nov 2004
• FormFieldsPlugin doesn't compile: Found = in conditional, should be == at ./lib/TWiki/Plugins/FormFieldsPlugin.pm line 260 (#2)
• FormPivotPlugin has problems: "my" variable $title masks earlier declaration in same scope at ./lib/TWiki/Plugins/FormPivotPlugin.pm line 165 (#3)
• MovableTypePlugin doesn't compile, and appears obsolete anyway
• PeerPlugin doesn't compile
• PdfPlugin uses SpacedWikiWordPlugin (!) but doesn't use it, and it wants to patch 'view'
  • Then it is a hacky AddOn, not a plugin. -- MartinCleaver - 25 Nov 2004
• Removed PageStatsPlugin because it depends on OoPlugin which doesn't have a plugin topic, and causes errors during plugin discovery..
• SearchToTablePlugin does not compile
• Removed ImmediateNotifyPlugin because CPAN:Net::Jabber didn't install
  • You sure that is a mandatory dependency? I have it running without Jabber! -- MartinCleaver - 25 Nov 2004
  • It isn't mandatory; but I am unzipping out of the box, with no further configuration other than satisfying dependencies it reports when first run up.
• AgentPlugin, BugzillaLinkPlugin, DiskUsagePlugin, EmbedPDFPlugin, LaTeXToMathMLPlugin, NotifyOnChildModificationPlugin, RicherSyntaxPlugin, XpTrackerPlugin all ship with DEBUG = 1
  • Sorry, will republish DiskUsagePlugin. -- MartinCleaver - 25 Nov 2004
• TranslateTagPlugin, NotifyOnChildModificationPlugin both write debug messages when DEBUG = 0
• LdapPlugin and LDAPPasswordChangerPlugin ship their plugin topic in Plugins web
• XpTrackerPlugin ships with ridiculous permissions in the zip
  • -rw------ on all files
• MailReminderPlugin ships pub/TWiki/exclam.gif.
• TopicVarsPlugin floods the apache log with "Uninitialized value" messages.
  • Yesterday I restored the previous 2003 version because functionality I'd added in 2004 is better implemented in MacrosPlugin. See TopicVarsPluginDev
• GuidPlugin fails to initPlugin correctly.

installation issues

• AbusePlugin - ABUSEFILE_LOCATION - need to specify file location, and upload a word filter file
• BlackListPlugin - needs additional setup (should be renamed throttler (what did i call it before??))
• CounterPlugin - COUNTERPLUGIN_COUNTER_FILE_PATH - /home/students/mtech03/rahulm/web/twiki/lib/TWiki/Plugins/datacount.txt!?!
• EmbedBibPlugin - need bibtool and bibtex2html
• TodaysVisitorsPlugin - configure the $TWIKILIBPATH var in lib/TWiki/Plugins/TodaysVisitorsPlugin.pm - configure the $LOGPATH var in lib/todaysvisitors.sh
• TWikiDrawPlugin - mostly ok; Template file twikidraw.tmpl not found or template directory /home/groups/t/tw/twikiplugins/twiki/templates not found.

wrong directory structure, won't install

• EmbedFlashPlugin - left EmbedFlashPlugin - wrong directory structure
• FormFieldsPlugin - wrong directory structure
• FormPivotPlugin - wrong directory structure#
• RevRecoverPlugin - left RevRecoverPlugin in (local) root
• RevisionLinkPlugin - left RevisionLinkPlugin in (local) root
• SyntaxHighlightingPlugin - wrong directory structure
• TocPlugin - left TocPlugin.xml in (local) root
• XpTrackerPlugin - wrong directory structure

plain old install/runtime errors

• AliasPlugin - []'s everywhere
• BugzillaQueryPlugin - can't test - says "can't connect to database", which is true for the default install
• CalendarPlugin - Can't continue after import errors at ../lib/TWiki/Plugins/CalendarPlugin.pm line 240 BEGIN failed--compilation aborted at ../lib/TWiki/Plugins/CalendarPlugin.pm line 240.
• DiskUsagePlugin - Illegal division by zero at ../lib/TWiki/Plugins/DiskUsagePlugin.pm line 158.
  • Will investigate -- MartinCleaver - 25 Nov 2004
• DoxygenPlugin - needs help
• ImageGalleryPlugin - mkdir problem, too
• IncludeRevisionPlugin - co: /home/groups/g/gd/gdutree/twiki/data/1/RCS/3.txt,v: No such file or directory
• JavaDocPlugin doesn't compile: Unmatched right curly bracket at ../lib/TWiki/Plugins/JavaDocPlugin.pm line 119, at end of line. The distribution also looks dodgy (it has a tmp directory at the install root level)
• LaTeXToMathMLPlugin - page rendered inside page, no math to be seen - don't know if it's a problem with this plugin, or an interaction with another one
• MathModePlugin - Not enough arguments for mkdir at ../lib/TWiki/Plugins/MathModePlugin.pm line 193, near "$path )
• MessageBoardPlugin - warnings.pm (?)
• PdfPlugin - nope
• PhantomPlugin - interacts with RicherSyntaxPlugin?
• TouchGraphPlugin - don't know why
  • See PTh's comment of Oct31 on TouchGraphPluginDev, something about the bin/tgdb script needing to run as the Apache user when installed on SF
• TypographyPlugin - doesn't seem to work

related to sourceforge restrictions (at least)

• HeadlinesPlugin - doesn't work from within sourceforge (http out)
• LocalCityTimePlugin - ERROR: TWiki::Net::getUrl connect: Connection timed out.

untested because they're "scary" user authentication stuff

• LDAPPasswordChangerPlugin
• LdapPlugin
• LoginNameAliasesPlugin

mail/notify - related stuff (also untested)

• ImmediateNotifyPlugin
• NotificationPlugin

can't test

• MsOfficeAttachmentsAsHTMLPlugin
  • Why? -- MartinCleaver - 25 Nov 2004
• DatabasePlugin - need db to test it with (also look into CPAN:SQL::Lite)
• MovableTypePlugin
• SiteMinderPlugin
• WebDAVPlugin

Notes on corrective actions taken

• FormFieldsPlugin has an extra top level in the zip
  • checked into CVSplugins:FormFieldsPlugin; new .zip needs to be generated and updated on FormFieldsPlugin
• Removed CounterPlugin because the plugin topic is in Main
  • checked into CVSplugins:CounterPlugin; new .zip needs to be generated and updated on CounterPlugin
• IrcLogPlugin doesn't initialise (the plugin topic is zipped in the distro), and when unzipped doesn't compile (Unrecognized character \x1F at ../lib/TWiki/Plugins/IrcLogPlugin.pm line 1)
  • checked into CVSplugins:IrcLogPlugin

Assuming these are automated tests, can we automate generation of a set of read-only topics - one per extension - and then include them at the top of the dev topics? -- MartinCleaver - 25 Nov 2004

Big assumption. My tests are not automated; TBH I don't know how you would automate them. -- CrawfordCurrie - 25 Nov 2004

CrawfordCurrie, WillNorris