blog.module

You are here

  1. 7 modules/blog/blog.module
  2. 4.6 modules/blog.module
  3. 4.7 modules/blog.module
  4. 5 modules/blog/blog.module
  5. 6 modules/blog/blog.module

Enables keeping an easily and regularly updated web page or a blog.

Functions

Namesort descending Description
blog_access Implementation of hook_access().
blog_block Implementation of hook_block().
blog_form Implementation of hook_form().
blog_help Implementation of hook_help().
blog_link Implementation of hook_link().
blog_menu Implementation of hook_menu().
blog_node_info Implementation of hook_node_info().
blog_page_user_access Access callback for user blog pages.
blog_perm Implementation of hook_perm().
blog_user Implementation of hook_user().
blog_view Implementation of hook_view().
_blog_post_exists Helper function to determine if a user has blog posts already.

File

modules/blog/blog.module
View source
  1. <?php
  2. /**
  3. * @file
  4. * Enables keeping an easily and regularly updated web page or a blog.
  5. */
  6. /**
  7. * Implementation of hook_node_info().
  8. */
  9. function blog_node_info() {
  10. return array(
  11. 'blog' => array(
  12. 'name' => t('Blog entry'),
  13. 'module' => 'blog',
  14. 'description' => t('A <em>blog entry</em> is a single post to an online journal, or <em>blog</em>.'),
  15. )
  16. );
  17. }
  18. /**
  19. * Implementation of hook_perm().
  20. */
  21. function blog_perm() {
  22. return array('create blog entries', 'delete own blog entries', 'delete any blog entry', 'edit own blog entries', 'edit any blog entry');
  23. }
  24. /**
  25. * Implementation of hook_access().
  26. */
  27. function blog_access($op, $node, $account) {
  28. switch ($op) {
  29. case 'create':
  30. // Anonymous users cannot post even if they have the permission.
  31. return user_access('create blog entries', $account) && $account->uid ? TRUE : NULL;
  32. case 'update':
  33. return user_access('edit any blog entry', $account) || (user_access('edit own blog entries', $account) && ($node->uid == $account->uid)) ? TRUE : NULL;
  34. case 'delete':
  35. return user_access('delete any blog entry', $account) || (user_access('delete own blog entries', $account) && ($node->uid == $account->uid)) ? TRUE : NULL;
  36. }
  37. }
  38. /**
  39. * Implementation of hook_user().
  40. */
  41. function blog_user($type, &$edit, &$user) {
  42. if ($type == 'view' && user_access('create blog entries', $user)) {
  43. $user->content['summary']['blog'] = array(
  44. '#type' => 'user_profile_item',
  45. '#title' => t('Blog'),
  46. // l() escapes the attributes, so we should not escape !username here.
  47. '#value' => l(t('View recent blog entries'), "blog/$user->uid", array('attributes' => array('title' => t("Read !username's latest blog entries.", array('!username' => $user->name))))),
  48. '#attributes' => array('class' => 'blog'),
  49. );
  50. }
  51. }
  52. /**
  53. * Implementation of hook_help().
  54. */
  55. function blog_help($path, $arg) {
  56. switch ($path) {
  57. case 'admin/help#blog':
  58. $output = '<p>'. t('The blog module allows registered users to maintain an online journal, or <em>blog</em>. Blogs are made up of individual <em>blog entries</em>, and the blog entries are most often displayed in descending order by creation time.') .'</p>';
  59. $output .= '<p>'. t('There is an (optional) <em>Blogs</em> menu item added to the Navigation menu, which displays all blogs available on your site, and a <em>My blog</em> item displaying the current user\'s blog entries. The <em>Blog entry</em> menu item under <em>Create content</em> allows new blog entries to be created.') .'</p>';
  60. $output .= '<p>'. t('Each blog entry is displayed with an automatic link to other blogs created by the same user. By default, blog entries have comments enabled and are automatically promoted to the site front page. The blog module also creates a <em>Recent blog posts</em> block that may be enabled at the <a href="@blocks">blocks administration page</a>.', array('@blocks' => url('admin/build/block'))) .'</p>';
  61. $output .= '<p>'. t('When using the aggregator module an automatic <em>blog it</em> icon is displayed next to the items in a feed\'s <em>latest items</em> block. Clicking this icon populates a <em>blog entry</em> with a title (the title of the feed item) and body (a link to the source item on its original site and illustrative content suitable for use in a block quote). Blog authors can use this feature to easily comment on items of interest that appear in aggregator feeds from other sites. To use this feature, be sure to <a href="@modules">enable</a> the aggregator module, <a href="@feeds">add and configure</a> a feed from another site, and <a href="@blocks">position</a> the feed\'s <em>latest items</em> block.', array('@modules' => url('admin/build/modules'), '@feeds' => url('admin/content/aggregator'), '@blocks' => url('admin/build/block'))) .'</p>';
  62. $output .= '<p>'. t('For more information, see the online handbook entry for <a href="@blog">Blog module</a>.', array('@blog' => 'http://drupal.org/handbook/modules/blog/')) .'</p>';
  63. return $output;
  64. }
  65. }
  66. /**
  67. * Implementation of hook_form().
  68. */
  69. function blog_form(&$node) {
  70. global $nid;
  71. $iid = isset($_GET['iid']) ? (int)$_GET['iid'] : 0;
  72. $type = node_get_types('type', $node);
  73. if (empty($node->body)) {
  74. // If the user clicked a "blog it" link, we load the data from the
  75. // database and quote it in the blog.
  76. if ($nid && $blog = node_load($nid)) {
  77. $node->body = '<em>'. $blog->body .'</em> ['. l($blog->name, "node/$nid") .']';
  78. }
  79. if ($iid && $item = db_fetch_object(db_query('SELECT i.*, f.title as ftitle, f.link as flink FROM {aggregator_item} i, {aggregator_feed} f WHERE i.iid = %d AND i.fid = f.fid', $iid))) {
  80. $node->title = $item->title;
  81. // Note: $item->description has been validated on aggregation.
  82. $node->body = '<a href="'. check_url($item->link) .'">'. check_plain($item->title) .'</a> - <em>'. $item->description .'</em> [<a href="'. check_url($item->flink) .'">'. check_plain($item->ftitle) ."</a>]\n";
  83. }
  84. }
  85. $form['title'] = array('#type' => 'textfield', '#title' => check_plain($type->title_label), '#required' => TRUE, '#default_value' => !empty($node->title) ? $node->title : NULL, '#weight' => -5);
  86. $form['body_field'] = node_body_field($node, $type->body_label, $type->min_word_count);
  87. return $form;
  88. }
  89. /**
  90. * Implementation of hook_view().
  91. */
  92. function blog_view($node, $teaser = FALSE, $page = FALSE) {
  93. if ($page) {
  94. // Breadcrumb navigation. l() escapes the title, so we should not escape !name.
  95. drupal_set_breadcrumb(array(l(t('Home'), NULL), l(t('Blogs'), 'blog'), l(t("!name's blog", array('!name' => $node->name)), 'blog/'. $node->uid)));
  96. }
  97. return node_prepare($node, $teaser);
  98. }
  99. /**
  100. * Implementation of hook_link().
  101. */
  102. function blog_link($type, $node = NULL, $teaser = FALSE) {
  103. $links = array();
  104. if ($type == 'node' && $node->type == 'blog') {
  105. if (arg(0) != 'blog' || arg(1) != $node->uid) {
  106. // This goes to l() and therefore escapes !username in both the title and attributes.
  107. $links['blog_usernames_blog'] = array(
  108. 'title' => t("!username's blog", array('!username' => $node->name)),
  109. 'href' => "blog/$node->uid",
  110. 'attributes' => array('title' => t("Read !username's latest blog entries.", array('!username' => $node->name)))
  111. );
  112. }
  113. }
  114. return $links;
  115. }
  116. /**
  117. * Implementation of hook_menu().
  118. */
  119. function blog_menu() {
  120. $items['blog'] = array(
  121. 'title' => 'Blogs',
  122. 'page callback' => 'blog_page_last',
  123. 'access arguments' => array('access content'),
  124. 'type' => MENU_SUGGESTED_ITEM,
  125. 'file' => 'blog.pages.inc',
  126. );
  127. $items['blog/%user_uid_optional'] = array(
  128. 'title' => 'My blog',
  129. 'page callback' => 'blog_page_user',
  130. 'page arguments' => array(1),
  131. 'access callback' => 'blog_page_user_access',
  132. 'access arguments' => array(1),
  133. 'file' => 'blog.pages.inc',
  134. );
  135. $items['blog/%user/feed'] = array(
  136. 'title' => 'Blogs',
  137. 'page callback' => 'blog_feed_user',
  138. 'page arguments' => array(1),
  139. 'access callback' => 'blog_page_user_access',
  140. 'access arguments' => array(1),
  141. 'type' => MENU_CALLBACK,
  142. 'file' => 'blog.pages.inc',
  143. );
  144. $items['blog/feed'] = array(
  145. 'title' => 'Blogs',
  146. 'page callback' => 'blog_feed_last',
  147. 'access arguments' => array('access content'),
  148. 'type' => MENU_CALLBACK,
  149. 'file' => 'blog.pages.inc',
  150. );
  151. return $items;
  152. }
  153. /**
  154. * Access callback for user blog pages.
  155. */
  156. function blog_page_user_access($account) {
  157. // The visitor must be able to access the site's content.
  158. // For a blog to 'exist' the user must either be able to
  159. // create new blog entries, or it must have existing posts.
  160. return $account->uid && user_access('access content') && (user_access('create blog entries', $account) || _blog_post_exists($account));
  161. }
  162. /**
  163. * Helper function to determine if a user has blog posts already.
  164. */
  165. function _blog_post_exists($account) {
  166. return (bool)db_result(db_query_range(db_rewrite_sql("SELECT 1 FROM {node} n WHERE n.type = 'blog' AND n.uid = %d AND n.status = 1"), $account->uid, 0, 1));
  167. }
  168. /**
  169. * Implementation of hook_block().
  170. *
  171. * Displays the most recent 10 blog titles.
  172. */
  173. function blog_block($op = 'list', $delta = 0) {
  174. global $user;
  175. if ($op == 'list') {
  176. $block[0]['info'] = t('Recent blog posts');
  177. return $block;
  178. }
  179. else if ($op == 'view') {
  180. if (user_access('access content')) {
  181. $result = db_query_range(db_rewrite_sql("SELECT n.nid, n.title, n.created FROM {node} n WHERE n.type = 'blog' AND n.status = 1 ORDER BY n.created DESC"), 0, 10);
  182. if ($node_title_list = node_title_list($result)) {
  183. $block['content'] = $node_title_list;
  184. $block['content'] .= theme('more_link', url('blog'), t('Read the latest blog entries.'));
  185. $block['subject'] = t('Recent blog posts');
  186. return $block;
  187. }
  188. }
  189. }
  190. }