mod/forum/backuplib.php

   1 <?PHP //$Id$
   2     //This php script contains all the stuff to backup/restore
   3     //forum mods
   4
   5     //This is the "graphical" structure of the forum mod:
   6     //
   7     //                           forum
   8     //                        (CL,pk->id)
   9     //                            |
  10     //             -----------------------------------
  11     //             |                                 |
  12     //        subscriptions                    forum_discussions
  13     //    (UL,pk->id, fk->forum)             (UL,pk->id, fk->forum)
  14     //                                               |
  15     //                                               |
  16     //                                               |
  17     //                                           forum_posts
  18     //                             (UL,pk->id,fk->discussion,nt->parent,files)
  19     //                                               |
  20     //                                               |
  21     //                                               |
  22     //                                          forum_ratings
  23     //                                      (UL,pk->id,fk->post)
  24     //
  25     // Meaning: pk->primary key field of the table
  26     //          fk->foreign key to link with parent
  27     //          nt->nested field (recursive data)
  28     //          CL->course level info
  29     //          UL->user level info
  30     //          files->table may have files)
  31     //
  32     //-----------------------------------------------------------
  33
  34     function forum_backup_mods($bf,$preferences) {
  35
  36         global $CFG;
  37
  38         $status = true;
  39
  40         //Iterate over forum table
  41         $forums = get_records ("forum","course",$preferences->backup_course,"id");
  42         if ($forums) {
  43             foreach ($forums as $forum) {
  44                 //Start mod
  45                 fwrite ($bf,start_tag("MOD",3,true));
  46                 //Print forum data
  47                 fwrite ($bf,full_tag("ID",4,false,$forum->id));
  48                 fwrite ($bf,full_tag("MODTYPE",4,false,"forum"));
  49                 fwrite ($bf,full_tag("TYPE",4,false,$forum->type));
  50                 fwrite ($bf,full_tag("NAME",4,false,$forum->name));
  51                 fwrite ($bf,full_tag("INTRO",4,false,$forum->intro));
  52                 fwrite ($bf,full_tag("OPEN",4,false,$forum->open));
  53                 fwrite ($bf,full_tag("ASSESSED",4,false,$forum->assessed));
  54                 fwrite ($bf,full_tag("ASSESSPUBLIC",4,false,$forum->assesspublic));
  55                 fwrite ($bf,full_tag("ASSESSTIMESTART",4,false,$forum->assesstimestart));
  56                 fwrite ($bf,full_tag("ASSESSTIMEFINISH",4,false,$forum->assesstimefinish));
  57                 fwrite ($bf,full_tag("MAXBYTES",4,false,$forum->maxbytes));
  58                 fwrite ($bf,full_tag("SCALE",4,false,$forum->scale));
  59                 fwrite ($bf,full_tag("FORCESUBSCRIBE",4,false,$forum->forcesubscribe));
  60                 fwrite ($bf,full_tag("TIMEMODIFIED",4,false,$forum->timemodified));
  61
  62                 //if we've selected to backup users info, then execute backup_forum_suscriptions and
  63                 //backup_forum_discussions
  64                 if ($preferences->mods["forum"]->userinfo) {
  65                     $status = backup_forum_subscriptions($bf,$preferences,$forum->id);
  66                     if ($status) {
  67                         $status = backup_forum_discussions($bf,$preferences,$forum->id);
  68                     }
  69                 }
  70                 //End mod
  71                 $status =fwrite ($bf,end_tag("MOD",3,true));
  72             }
  73         }
  74         //if we've selected to backup users info, then backup files too
  75         if ($status) {
  76             if ($preferences->mods["forum"]->userinfo) {
  77                 $status = backup_forum_files($bf,$preferences);
  78             }
  79         }
  80         return $status;
  81     }
  82
  83     //Backup forum_subscriptions contents (executed from forum_backup_mods)
  84     function backup_forum_subscriptions ($bf,$preferences,$forum) {
  85
  86         global $CFG;
  87
  88         $status = true;
  89
  90         $forum_subscriptions = get_records("forum_subscriptions","forum",$forum,"id");
  91         //If there is subscriptions
  92         if ($forum_subscriptions) {
  93             //Write start tag
  94             $status =fwrite ($bf,start_tag("SUBSCRIPTIONS",4,true));
  95             //Iterate over each answer
  96             foreach ($forum_subscriptions as $for_sus) {
  97                 //Start suscription
  98                 $status =fwrite ($bf,start_tag("SUBSCRIPTION",5,true));
  99                 //Print forum_subscriptions contents
 100                 fwrite ($bf,full_tag("ID",6,false,$for_sus->id));
 101                 fwrite ($bf,full_tag("USERID",6,false,$for_sus->userid));
 102                 //End subscription
 103                 $status =fwrite ($bf,end_tag("SUBSCRIPTION",5,true));
 104             }
 105             //Write end tag
 106             $status =fwrite ($bf,end_tag("SUBSCRIPTIONS",4,true));
 107         }
 108         return $status;
 109     }
 110
 111     //Backup forum_discussions contents (executed from forum_backup_mods)
 112     function backup_forum_discussions ($bf,$preferences,$forum) {
 113
 114         global $CFG;
 115
 116         $status = true;
 117
 118         $forum_discussions = get_records("forum_discussions","forum",$forum,"id");
 119         //If there are discussions
 120         if ($forum_discussions) {
 121             //Write start tag
 122             $status =fwrite ($bf,start_tag("DISCUSSIONS",4,true));
 123             //Iterate over each discussion
 124             foreach ($forum_discussions as $for_dis) {
 125                 //Start discussion
 126                 $status =fwrite ($bf,start_tag("DISCUSSION",5,true));
 127                 //Print forum_discussions contents
 128                 fwrite ($bf,full_tag("ID",6,false,$for_dis->id));
 129                 fwrite ($bf,full_tag("NAME",6,false,$for_dis->name));
 130                 fwrite ($bf,full_tag("FIRSTPOST",6,false,$for_dis->firstpost));
 131                 fwrite ($bf,full_tag("USERID",6,false,$for_dis->userid));
 132                 fwrite ($bf,full_tag("GROUPID",6,false,$for_dis->groupid));
 133                 fwrite ($bf,full_tag("ASSESSED",6,false,$for_dis->assessed));
 134                 fwrite ($bf,full_tag("TIMEMODIFIED",6,false,$for_dis->timemodified));
 135                 fwrite ($bf,full_tag("USERMODIFIED",6,false,$for_dis->usermodified));
 136                 //Now print posts to xml
 137                 $status = backup_forum_posts($bf,$preferences,$for_dis->id);
 138                 //End discussion
 139                 $status =fwrite ($bf,end_tag("DISCUSSION",5,true));
 140             }
 141             //Write end tag
 142             $status =fwrite ($bf,end_tag("DISCUSSIONS",4,true));
 143         }
 144         return $status;
 145     }
 146
 147     //Backup forum_posts contents (executed from backup_forum_discussions)
 148     function backup_forum_posts ($bf,$preferences,$discussion) {
 149
 150         global $CFG;
 151
 152         $status = true;
 153
 154         $forum_posts = get_records("forum_posts","discussion",$discussion,"id");
 155         //If there are posts
 156         if ($forum_posts) {
 157             //Write start tag
 158             $status =fwrite ($bf,start_tag("POSTS",6,true));
 159             //Iterate over each post
 160             foreach ($forum_posts as $for_pos) {
 161                 //Start post
 162                 $status =fwrite ($bf,start_tag("POST",7,true));
 163                 //Print forum_posts contents
 164                 fwrite ($bf,full_tag("ID",8,false,$for_pos->id));
 165                 fwrite ($bf,full_tag("PARENT",8,false,$for_pos->parent));
 166                 fwrite ($bf,full_tag("USERID",8,false,$for_pos->userid));
 167                 fwrite ($bf,full_tag("CREATED",8,false,$for_pos->created));
 168                 fwrite ($bf,full_tag("MODIFIED",8,false,$for_pos->modified));
 169                 fwrite ($bf,full_tag("MAILED",8,false,$for_pos->mailed));
 170                 fwrite ($bf,full_tag("SUBJECT",8,false,$for_pos->subject));
 171                 fwrite ($bf,full_tag("MESSAGE",8,false,$for_pos->message));
 172                 fwrite ($bf,full_tag("FORMAT",8,false,$for_pos->format));
 173                 fwrite ($bf,full_tag("ATTACHMENT",8,false,$for_pos->attachment));
 174                 fwrite ($bf,full_tag("TOTALSCORE",8,false,$for_pos->totalscore));
 175                 //Now print ratings to xml
 176                 $status = backup_forum_ratings($bf,$preferences,$for_pos->id);
 177
 178                 //End discussion
 179                 $status =fwrite ($bf,end_tag("POST",7,true));
 180             }
 181             //Write end tag
 182             $status =fwrite ($bf,end_tag("POSTS",6,true));
 183         }
 184         return $status;
 185     }
 186
 187
 188     //Backup forum_ratings contents (executed from backup_forum_posts)
 189     function backup_forum_ratings ($bf,$preferences,$post) {
 190
 191         global $CFG;
 192
 193         $status = true;
 194
 195         $forum_ratings = get_records("forum_ratings","post",$post,"id");
 196         //If there are ratings
 197         if ($forum_ratings) {
 198             //Write start tag
 199             $status =fwrite ($bf,start_tag("RATINGS",8,true));
 200             //Iterate over each rating
 201             foreach ($forum_ratings as $for_rat) {
 202                 //Start rating
 203                 $status =fwrite ($bf,start_tag("RATING",9,true));
 204                 //Print forum_rating contents
 205                 fwrite ($bf,full_tag("ID",10,false,$for_rat->id));
 206                 fwrite ($bf,full_tag("USERID",10,false,$for_rat->userid));
 207                 fwrite ($bf,full_tag("TIME",10,false,$for_rat->time));
 208                 fwrite ($bf,full_tag("POST_RATING",10,false,$for_rat->rating));
 209                 //End rating
 210                 $status =fwrite ($bf,end_tag("RATING",9,true));
 211             }
 212             //Write end tag
 213             $status =fwrite ($bf,end_tag("RATINGS",8,true));
 214         }
 215         return $status;
 216     }
 217
 218     //Backup forum files because we've selected to backup user info
 219     //and files are user info's level
 220     function backup_forum_files($bf,$preferences) {
 221
 222         global $CFG;
 223
 224         $status = true;
 225
 226         //First we check to moddata exists and create it as necessary
 227         //in temp/backup/$backup_code  dir
 228         $status = check_and_create_moddata_dir($preferences->backup_unique_code);
 229         //Now copy the forum dir
 230         if ($status) {
 231             //Only if it exists !! Thanks to Daniel Miksik.
 232             if (is_dir($CFG->dataroot."/".$preferences->backup_course."/".$CFG->moddata."/forum")) {
 233                 $status = backup_copy_file($CFG->dataroot."/".$preferences->backup_course."/".$CFG->moddata."/forum",
 234                                            $CFG->dataroot."/temp/backup/".$preferences->backup_unique_code."/moddata/forum");
 235             }
 236         }
 237
 238         return $status;
 239
 240     }
 241
 242
 243    ////Return an array of info (name,value)
 244    function forum_check_backup_mods($course,$user_data=false,$backup_unique_code) {
 245         //First the course data
 246         $info[0][0] = get_string("modulenameplural","forum");
 247         if ($ids = forum_ids ($course)) {
 248             $info[0][1] = count($ids);
 249         } else {
 250             $info[0][1] = 0;
 251         }
 252
 253         //Now, if requested, the user_data
 254         if ($user_data) {
 255             //Subscriptions
 256             $info[1][0] = get_string("subscriptions","forum");
 257             if ($ids = forum_subscription_ids_by_course ($course)) {
 258                 $info[1][1] = count($ids);
 259             } else {
 260                 $info[1][1] = 0;
 261             }
 262             //Discussions
 263             $info[2][0] = get_string("discussions","forum");
 264             if ($ids = forum_discussion_ids_by_course ($course)) {
 265                 $info[2][1] = count($ids);
 266             } else {
 267                 $info[2][1] = 0;
 268             }
 269             //Posts
 270             $info[3][0] = get_string("posts","forum");
 271             if ($ids = forum_post_ids_by_course ($course)) {
 272                 $info[3][1] = count($ids);
 273             } else {
 274                 $info[3][1] = 0;
 275             }
 276             //Ratings
 277             $info[4][0] = get_string("ratings","forum");
 278             if ($ids = forum_rating_ids_by_course ($course)) {
 279                 $info[4][1] = count($ids);
 280             } else {
 281                 $info[4][1] = 0;
 282             }
 283         }
 284         return $info;
 285     }
 286
 287
 288
 289
 290
 291
 292     // INTERNAL FUNCTIONS. BASED IN THE MOD STRUCTURE
 293
 294     //Returns an array of forums id
 295     function forum_ids ($course) {
 296
 297         global $CFG;
 298
 299         return get_records_sql ("SELECT a.id, a.course
 300                                  FROM {$CFG->prefix}forum a
 301                                  WHERE a.course = '$course'");
 302     }
 303
 304     //Returns an array of forum subscriptions id
 305     function forum_subscription_ids_by_course ($course) {
 306
 307         global $CFG;
 308
 309         return get_records_sql ("SELECT s.id , s.forum
 310                                  FROM {$CFG->prefix}forum_subscriptions s,
 311                                       {$CFG->prefix}forum a
 312                                  WHERE a.course = '$course' AND
 313                                        s.forum = a.id");
 314     }
 315
 316     //Returns an array of forum discussions id
 317     function forum_discussion_ids_by_course ($course) {
 318
 319         global $CFG;
 320
 321         return get_records_sql ("SELECT s.id , s.forum
 322                                  FROM {$CFG->prefix}forum_discussions s,
 323                                       {$CFG->prefix}forum a
 324                                  WHERE a.course = '$course' AND
 325                                        s.forum = a.id");
 326     }
 327
 328     //Returns an array of forum posts id
 329     function forum_post_ids_by_course ($course) {
 330
 331         global $CFG;
 332
 333         return get_records_sql ("SELECT p.id , p.discussion, s.forum
 334                                  FROM {$CFG->prefix}forum_posts p,
 335                                       {$CFG->prefix}forum_discussions s,
 336                                       {$CFG->prefix}forum a
 337                                  WHERE a.course = '$course' AND
 338                                        s.forum = a.id AND
 339                                        p.discussion = s.id");
 340     }
 341
 342     //Returns an array of ratings posts id
 343     function forum_rating_ids_by_course ($course) {
 344
 345         global $CFG;
 346
 347         return get_records_sql ("SELECT r.id, r.post, p.discussion, s.forum
 348                                  FROM {$CFG->prefix}forum_ratings r,
 349                                       {$CFG->prefix}forum_posts p,
 350                                       {$CFG->prefix}forum_discussions s,
 351                                       {$CFG->prefix}forum a
 352                                  WHERE a.course = '$course' AND
 353                                        s.forum = a.id AND
 354                                        p.discussion = s.id AND
 355                                        r.post = p.id");
 356     }
 357 ?>