webbuilders-group / silverstripe-kapost-bridge Goto Github PK

It looks like for some reason when a validation exception is thrown in the processing of incoming content the message is not returned to Kapost when it should. Kapost is just reporting a internal server error.

We should add support for file content types, see https://developer.kapost.com/xmlrpc-files

Currently each new KapostObject extension must have a new conversion history class, and the primary reasoning for this is to simply send the destination link somewhere else. We could probably re-work this so the conversion history record by default pulls the edit link from the destination object.

We should add support for conversion history notes to the conversion process in general I'm thinking it should work like the following rough notes:

• Use kapost field name SS_Notes or similar
• Need to store kapost author avatar on kapost object if not already stored
• Should appear in conversion dialog floating bouncing icon of author avatar, maybe also somehow include their name?
• Clicking trigger shows balloon popup width 80%, max height 80% that contains conversion notes with authors name either before or after the notes
• Maybe use absolute for trigger so it doesn't interfere with other content in conversion dialog

We need to add note about publish again after conversion to get the correct publish URL in Kapost for analytics on their end.

We should come up with away to strip (if possible) the tag added to the description field when the Kapost content author(s) use the comment feature of the WYSIWYG. It shouldn't be an overly impactful thing if we can't strip it but it would be nice if we could with minimal overhead but good accuracy.

For reference this appears to be what is added to the content, at the very least we should strip the inner span.

<span><span thread="1234567890" class="thread">dolor tortor eget mauris</span></span>

We should allow SS_Log the option to handle errors from the Kapost bridge, currently it looks like phpxmlrpc is trapping the exceptions because of the exception handling level being used thus not allowing them to reach SS_Log or any other error handling. At the very least we should have our module trap the errors and report them accordingly through to Kapost while still allowing SS_Log to function. We should also ensure that we allow extensions to tap into this just in case.

We should remove the ability to create a new object during conversion when the system identifies the content as replacing another piece of content. As it currently works if you choose new object during conversion when the system identified it as replacing only the first one encountered will be updating when converting. Which would have been the original one identified as to be replaced.

We should also update the documentation about custom types to also reflect this.

We should improve the handling of http requests to endpoint. Currently hitting the kapost-service endpoint it just returns an XML parsing error in the request. We should instead return a 404 error page.

We should add away for the conversion process to notice that the title has changed on the incoming Kapost Page and offer to change the url segment and give the user the ability to edit it.

Within Kapost ingestion process (model admin), while editing a Kapost Object in Silverstripe, the 'Kapost Reference ID' should be linkable back to the Content in Kapost.

We should come up with away to do inbound content validation easily in the KapostService class. Either through the built in DataObject::validate() or through a KapostObject::validate_incoming() (for example).

We should consider removing the ability to delete conversion history items since this is currently automated by default every 30 days.

It looks like when the option "Publish as array" is set for Kapost custom fields the field is a base64 encoded json style array. We should look for and auto process these into a php array, when we find a key that matches we should remove that key and add a key without the _kapost_array_ prefix that has the json decoded array.

Within the Kapost ingestion/model admin in SilverStripe there should be a new tab, "Log" that shows previously converted Kapost objects. It should just summarize information about the conversion, fields that may be relevant include:

• Kapost Author
• Kapost publish date
• Title of the object
• SilverStripe CMS admin/username
• SilverStripe conversion date
• A link to the converted SS Page/resource
• Other?

Also consider a solution (i.e. cron) that routinely cleans out these records (i.e. every 30 days).

We should update the new media asset tests to account for each of the duplicate handling methods. Those methods are smart_rename (default), rename, overwrite, and ignore. Currently it only tests the default.

The Author from Kapost should be captured during the ingestion and made visible on the Kapost Object in SilverStripe.

We should implement away to preview content from SilverStripe how will this work? How do we best secure it maybe authentication in the url? See here for more info.

We should have support making specific items in the settings tab also readonly when using the KapostPageEditControllerExtension that or provide another extension to handle this which is likely the better/only way since the settings tab on pages is actually handled by CMSPageSettingsController.

Currently we're using the 3.0.x release chain of phpxmlrpc, we really should update our requirement to the 4.x chain the newer versions include allot of improvements. See here for some upgrading information.

It would be nice to have a button above the table in the model admin for kapost objects that refreshes the table when clicked.

Currently Kapost does not send the HTML Title or Meta Description from the SEO section of a content object in the XML-RPC. Kapost has been contacted on this, we'll see what they have to say. But ideally these would map per-bellow. My understanding is that these fields are only served with supported SEO plugins for CMS'es like Wordpress.

We should have the edit page show a message at the top if the page is controlled by Kapost and there are changes waiting. There should be a link that lets you quickly jump to that section of the cms.

We should update our documentation to detail how to use KapostObject::validate_incoming() and that it exists.

We should handle when a page type changes from kapost, this would require resetting the class name on the destination page when replacing a page. As well we may need to re-query to update the object.

When searching for content the DateTime field is causing a warning to be generated because it's value in the parameters array is itself an array. We'll need to normalize these values somehow or at least account for it before the filters are applied.

Looks like in Chrome a bug in the rendering is causing the title bar to appear much taller than it should, we should consider switching to flex box to address this issue and dump jLayout.

We should have an option to bypass the Kapost section in the cms and straight convert objects. If this setting is enabled we should remove the item from the cms menu to avoid confusion. As well the Kapost publish buttons should drive which status the converted page goes into, grey button (Publish as Draft I believe) should convert to the SilverStripe draft site. Where as the blue button should convert to the live website. This would only effect pages, for regular data objects we should just convert and write them.

We'll need to ensure we have extension points to poke in during and potentially after the conversion process to allow for extensions to adjust the conversion process for stuff like automatically handling relationship setting.

We'll also need in the case of pages to have an optional default parent setting for example maybe a site only uses Kapost for a blog in which case we would want it to assign to the blog holder as a parent.

Currently the module only supports cms and framework projects. I wonder if it is possible to strip it down to support framework only projects? Technically we could if SiteTree is not present we just don't handle KapostPage and require that extensions handle the response.

We should write some unit tests using mock Kapost requests and setup TravisCI hooks as well.

We should add a configuration option for handling of assets, currently everytime an asset comes into the system it is downloaded and added to the assets folder/File table. It would be ideal to allow developers to be able to decide how these are handled with 3 options:

Rename (default):

KapostService:
    duplicate_assets: "rename"

Overwrite (should warn in docs about this):

KapostService:
    duplicate_assets: "overwrite"

Ignore (in this case the original should be returned in the response or an error, tbd):

KapostService:
    duplicate_assets: "ignore"

We should improve the handling of validation errors during conversion so that they are relayed back as an error on the form rather than a hard stop like they currently are.