vBulletin LTS

PHPKD - vB Blog Feed Poster
Mod Version: 4.2.100, by Omranic

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!.................. Brought to you by PHP KingDom (http://www.phpkd.net) ..................!
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Please remember to click Mark as Installed if you use this product.
Support requests from members who have not marked this as installed will be considered low priority.

Name: PHPKD - vB Blog Feed Poster
Version: 4.2.100

Description: This product allows users to add feeds to their blogs (RSS/Atom) & their blogs will automatically fetches & posts new items in their from those feeds periodically. User's has full control over feeds' behavior & staff have also full admin control.

Compatible with: All 4.0.x/4.1.x/4.2.x vBulletin versions.

Requirements:

• vBulletin version 4.0.x/4.1.x/4.2.x

License:

• http://info.phpkd.net/en/license/free/

Helpful links:

• http://forum.phpkd.net/project.php?do=issuelist&projectid=2&issuetypeid=bug
• http://forum.phpkd.net/project.php?do=issuelist&projectid=2&issuetypeid=feature

Features:

• General Features:-
  
  • Fully Phrased.
    
  • Fully Automated.
    
  • Fully Supported.
    
  • Accurate Processing.
    
  • Professionally Coded.
    
  • Doesn't require any manual edits.
    
  • Doing all default vBulletin checks & Fully vBulletin/vBblog Compatible.
    
  • Board/Blog Load Zero Queries, queries only when the scheduled task run.
    
  • The product has a cron job (Scheduled Task) that run every 10 minutes to do processes. If you run the cron job from the AdminCP manually, then you will get a report of the process & the fetched items instantly for your review.
    
  • The Cron job (scheduled Task) logs every run details in "Scheduled Task Log", so you can review it later.
    
  • All staff management actions through AdminCP & ModCP are logged in the "Control Panel Log".
    
  • Hooks are embeded within product's files, so it's functionality can be extended later easily.
    
  • The product's code base is very solid/rich & has many possibilities to help in future development.
    
  
  
• Specific Features:-
  
  • Feed Options/Features:
    
    • Main Options:
      
      • Can be enabled/disabled by user/staff.
        
      • Can be approved/disapproved by staff.
        
      • Feed URL (All feed types from any website over the world are acceptable as soon as it's a valid feed URL: RSS 1, RSS 2, XML, ATOM all acceptable).
        
      • Feed Name (Title).
        
      • Feed Description (Short Informative description).
        
      • Display Order.
        
      • Maximum Items to Fetch (each run).
        
      • Title Template.
        
      • Body Template.
        
        • The two templates ("Title Template", "Body Template") are used for the title (title template) and body (body template) of messages posted by the Feed poster.
          
        • You can specify exactly how these items appear and any item from a feed can be inserted by using {feed:fieldname} where 'fieldname' corresponds to one of the following: title, description, link, id, date, enclosure_href and content:encoded.
          
        • If the feed supports content:encoded. Then imported feeds may appear nicer if you use {feed:content:encoded} in your "Body Template" instead of {feed:description} and enable the Convert HTML to BB Code option.
          
      • Blog Entry Type: Fetched Items can be posted as (Visible Entries/Draft Entries).
        
      • Check Feed Every: This Feed should be checked for new items every how many minutes/Hours.
        
      
      
    • Blog Entry Options:
      
      • Allow comments to be posted (Yes/No).
        
      • Moderate comments before displaying (Yes/No).
        
      • Allow trackback / pingback (Yes/No).
        
      • Notify blogs linked within this blog entry (Yes/No).
        
      • Restrict entry viewing to Contacts and Blog Moderators (Yes/No).
        
      
      
    • Miscellaneous Options:
      
      • Allow Smilies (Yes/No).
        
      • Convert HTML to BB Code (Yes/No).
        
      • Automatically parse links in text (Yes/No).
        
      • Publish blog entries with their original publish date (Yes/No).
        - If checked, then fetched entries will be posted with their original post date, otherwise it will be posted with the time it's posted in.
        
      
      
    • Blog Entry Subscription: (Don't Subscribe / No Email Notification / Instant Email Notification)
      
      
    • Edit Options:
      
      • Can Reset Last Run Time (If has permission to do so).
        
      • Can Delete Feed (If has permission to do so).
        
      • Can Approve/Disapprove Feed (If has permission to do so).
        
      
      
    • Admincp Features:
      
      • Statistics:
        Detailed statistics in the AdminCP index page
        
        • Total Feeds Count
          
        • New Feeds Today
          
        • Approved Feeds Count
          
        • Feeds to Moderate
          
        • Active Feeds Count
          
        • Inactive Feeds Count
          
        • Users have Feeds
          
        • Feeds Run Today
          
        • Blog Entries Posted through Feeds
          
        • Blog Entries Posted through Feeds Today
          
        Most of these statistics with links to view/sort results within admincp & control/moderate it.
        
        
      • Moderation Permissions:
        
        • Administration & Moderation Staff can granted permissions to control & moderate feeds from within the forum itself or from within AdminCP or ModCP
          
        • If the staff member has "Administration control panel" access then he's granted it by default, if not then a supervisor staff can give it to him (per blog moderator). Just follow these simple steps:
          - vBulletin Blog -> Blog Moderators -> Beside each blog moderator click "[Edit Permissions]" -> Can Edit Blog Feeds (On/Off) [Check "Yes"]
          
        
        
      • AdminCP/ModCP Moderation page features/options:
        First of all, all feeds are categorized per user & sorted by username alphabetically, and then for each user's feeds it's categorized by display order ascending.
        For each feed you can:
        
        • Click:
          - Feed's name: To go to the full editor page within forum & edit that feed's details.
          - Edit: To go to the full editor page within forum & edit that feed's details (Same as above).
          - Feed's URL: To go to the Feed URL itself.
          
          
        • See:
          - "Blog Entry Type": In which mode 'new fetched items' are posted in. (Visible/Draft)
          - "Check Feed Every": This Feed has to be checked for new items every how many minutes.
          - Feed's "Last Run": Is that feed run before, if 'yes' then when.
          
          
        • See & Mass Edit:
          - "Display Order": You can mass edit display order for all feeds.
          - "Status": You can mass edit status for all feeds displayed (Enabled/Disabled).
          - "Moderation Status": You can mass edit "Moderation Status" for all feeds displayed (Approved/Disapproved).
          - Reset "Last Run Time": You can mass reset "last run time" for all feeds displayed.
          - Delete: You can mass delete some or all displayed feeds by few simple clicks.
          
        
        ** All of the above control options are flexible, you can select any action you need to process on a specific feed, and choose another action to process on another feed, no problem, just do your checks & click "Save Changes" & the system will do all the work for you all over the selected actions/selected feeds as needed by just few simple clicks. It's the ultimate flexibility! **
        
        
      • Usergroup Permissions:
        
        • Can Create Own Blog Feeds (Yes/No).
          
        • Moderate Feeds By Default (Yes/No).
          - (If "Yes", then new feeds should be approved by administration first before begin working)
          
        • Can Mass Manage Feeds (Yes/No).
          
        • Can Delete Own Feeds (Yes/No).
          
        • Can Reset Feed's Last Run Time (Yes/No).
          
        • Maximum Feeds Allowed (Number).
          

Installation/Upgrade Procedure:

1. Upload required files to their appropriate places (If upgrading: ALLOW OVERRIDE):
   
   • images
     
     • misc
       
       • feed_add.png
         
   • includes
     
     • cron
       
       • blog_phpkd_vbbfp.php
         
     • xml
       
       • bitfield_phpkd_vbbfp.xml
         
       • cpnav_phpkd_vbbfp.xml
         
       • hooks_phpkd_vbbfp.xml
         
     • blog_functions_phpkd_vbbfp.php
       
     • class_dm_blog_phpkd_vbbfp.php
       
   • modcp
     
     • blog_phpkd_vbbfp.php
       
   • blog_phpkd_vbbfp.php
     
2. Import the product's XML file "product-phpkd_vbbfp.xml" from AdminCP (If upgrading: ALLOW OVERRIDE).
3. Configure product's permissions.
4. You're Done .

Controls:

• AdminCP Usergroup Permissions:
  vBulletin AdminCP -> Usergroup Manager -> Select "Edit Permissions" for any usergroup -> PHPKD - vB Blog RSS Poster
• AdminCP Blog Moderation Permissions:
  vBulletin Blog -> Blog Moderators -> Beside each blog moderator click "[Edit Permissions]" -> Can Edit Blog Feeds (On/Off)
• AdminCP Edit user's feeds link:
  Search for any user & go to his profile within AdminCP -> Quick User Links -> Open the select menu -> select "Edit Blog Feeds" (option)
• AdminCP Moderate Feeds Link:
  vBulletin AdminCP -> vBulletin Blog -> Blog Feeds
• ModCP Moderate Feeds Link:
  vBulletin ModCP -> Moderate Blog Feeds -> Moderate Blog Feeds
• Moderate Feeds from within the forum itself:
  http://FORUM_LINK/blog_phpkd_vbbfp.php?do=editfeeds&u=USERID
  Where 'FORUM_LINK' is your forum's link & 'USERID' is user's ID that you need to edit/manage/control his/her blog feeds.

Note: There is many ways to control/manage/moderate users' feeds, you can do so from within the forum itself without logging to AdminCP, you can do it from within ModCP, and you can do it from within AdminCP. It's the maximum usability/flexibility, all features of course are controlled by suitable permissions.

Help with:

• Suggestions & feature requests to develop this product.
  
• Contributing any updates, upgrades and/or any new features.
  
• Translations to benefit more users (translation credits goes to their owners).
  
• Spreading this product. Yes, you're free to re-distribute this product as it is (See license details).

History:

• v3.8.100 26/09/2009 08:00 AM UTC: First initial public release.
  
• v4.2.100 21/06/2012 10:00 PM UTC: First initial 4.x.x public release.

License:
--------------- --------------- --------------- ---------------
Creative Commons - Attribution-Noncommercial-Share Alike 3.0
http://creativecommons.org/licenses/by-nc-sa/3.0/
--------------- --------------- --------------- ---------------

• You are free:
  • To Share — to copy, distribute and transmit the work.
  • To Remix — to adapt the work.
  
  
• Under the following conditions:
  • [Attribution]: You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).
  • [Noncommercial]: You may not use this work for commercial purposes.
  • [Share Alike]: If you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.
  
  
• For any reuse or distribution, you must make clear to others the original author's copyrights AND you must make clear to others the license terms of this work. The best way to do this is with a link to this web page (http://creativecommons.org/licenses/by-nc-sa/3.0/).
• Any of the above conditions can be waived if you get permission from the copyright holder (The original product's author).
• Nothing in this license impairs or restricts the author's moral rights.

--------------- --------------- --------------- ---------------
Your fair dealing and other rights are in no way affected by the above.
This is a human-readable summary of the Legal Code (the full license).
http://creativecommons.org/licenses/by-nc-sa/3.0/legalcode
--------------- --------------- --------------- ---------------