123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715 |
- <?php
- define('INSTALLDIR', dirname(__DIR__));
- define('PUBLICDIR', INSTALLDIR . DIRECTORY_SEPARATOR . 'public');
- $shortoptions = 'dfx::';
- $longoptions = ['debug', 'files', 'extensions='];
- $helptext = <<<END_OF_UPGRADE_HELP
- php upgrade.php [options]
- Upgrade database schema and data to latest software
- END_OF_UPGRADE_HELP;
- require_once INSTALLDIR.'/scripts/commandline.inc';
- if (!defined('DEBUG')) {
- define('DEBUG', (bool)have_option('d', 'debug'));
- }
- function main()
- {
-
-
- $iterate_files = (bool)have_option('f', 'files');
- if (Event::handle('StartUpgrade')) {
- fixupConversationURIs();
- updateSchemaCore();
- updateSchemaPlugins();
-
- fixupNoticeConversation();
- initConversation();
- fixupUserBadNulls();
- fixupGroupURI();
- if ($iterate_files) {
- printfnq("* "); fixupFileGeometry();
- printfnq("* "); deleteLocalFileThumbnailsWithoutFilename();
- printfnq("* "); deleteMissingLocalFileThumbnails();
- printfnq("* "); fixupFileThumbnailUrlhash();
- printfnq("* "); setFilehashOnLocalFiles();
- printfnq("DONE.\n");
- } else {
- printfnq("Skipping intensive/long-running file iteration functions (enable with -f, should be done at least once!)\n");
- }
- initGroupProfileId();
- initLocalGroup();
- initNoticeReshare();
- initSubscriptionURI();
- initGroupMemberURI();
- initProfileLists();
- migrateProfilePrefs();
- Event::handle('EndUpgrade');
- }
- }
- function tableDefs()
- {
- $schema = [];
- require INSTALLDIR . '/db/core.php';
- return $schema;
- }
- function updateSchemaCore()
- {
- printfnq("Upgrading core schema...");
- $schema = Schema::get();
- $schemaUpdater = new SchemaUpdater($schema);
- foreach (tableDefs() as $table => $def) {
- $schemaUpdater->register($table, $def);
- }
- $schemaUpdater->checkSchema();
- printfnq("DONE.\n");
- }
- function updateSchemaPlugins()
- {
- printfnq("Upgrading plugin schema...");
- Event::handle('BeforePluginCheckSchema');
- Event::handle('CheckSchema');
- printfnq("DONE.\n");
- }
- function fixupUserBadNulls(): void
- {
- printfnq("Ensuring all users have no empty strings for NULLs...");
- foreach (['email', 'incomingemail', 'sms', 'smsemail'] as $col) {
- $user = new User();
- $user->whereAdd("{$col} = ''");
- if ($user->find()) {
- while ($user->fetch()) {
- $user->query(sprintf(
- <<<'END'
- UPDATE %1$s
- SET %2$s = NULL, modified = CURRENT_TIMESTAMP
- WHERE id = %3$d
- END,
- $user->escapedTableName(),
- $col,
- $user->getID()
- ));
- }
- }
- }
- printfnq("DONE.\n");
- }
- function fixupNoticeConversation()
- {
- printfnq("Ensuring all notices have a conversation ID...");
- $notice = new Notice();
- $notice->whereAdd('conversation is null');
- $notice->whereAdd('conversation = 0', 'OR');
- $notice->orderBy('id'); // try to get originals before replies
- $notice->find();
- while ($notice->fetch()) {
- try {
- $cid = null;
- $orig = clone($notice);
- if (!empty($notice->reply_to)) {
- $reply = Notice::getKV('id', $notice->reply_to);
- if ($reply instanceof Notice && !empty($reply->conversation)) {
- $notice->conversation = $reply->conversation;
- }
- unset($reply);
- }
- // if still empty
- if (empty($notice->conversation)) {
- $child = new Notice();
- $child->reply_to = $notice->getID();
- $child->limit(1);
- if ($child->find(true) && !empty($child->conversation)) {
- $notice->conversation = $child->conversation;
- }
- unset($child);
- }
- // if _still_ empty we just create our own conversation
- if (empty($notice->conversation)) {
- $notice->conversation = $notice->getID();
- }
- $result = $notice->update($orig);
- unset($orig);
- } catch (Exception $e) {
- print("Error setting conversation: " . $e->getMessage());
- }
- }
- printfnq("DONE.\n");
- }
- function fixupGroupURI()
- {
- printfnq("Ensuring all groups have an URI...");
- $group = new User_group();
- $group->whereAdd('uri IS NULL');
- if ($group->find()) {
- while ($group->fetch()) {
- $orig = User_group::getKV('id', $group->id);
- $group->uri = $group->getUri();
- $group->update($orig);
- }
- }
- printfnq("DONE.\n");
- }
- function initConversation()
- {
- if (common_config('fix', 'upgrade_initConversation') <= 1) {
- printfnq(sprintf("Skipping %s, fixed by previous upgrade.\n", __METHOD__));
- return;
- }
- printfnq("Ensuring all conversations have a row in conversation table...");
- $notice = new Notice();
- $notice->selectAdd();
- $notice->selectAdd('DISTINCT conversation');
- $notice->joinAdd(['conversation', 'conversation:id'], 'LEFT'); // LEFT to get the null values for conversation.id
- $notice->whereAdd('conversation.id IS NULL');
- if ($notice->find()) {
- printfnq(" fixing {$notice->N} missing conversation entries...");
- }
- while ($notice->fetch()) {
- $id = $notice->conversation;
- $uri = common_local_url('conversation', ['id' => $id]);
- // @fixme db_dataobject won't save our value for an autoincrement
- // so we're bypassing the insert wrappers
- $conv = new Conversation();
- $sql = "INSERT INTO conversation (id,uri,created) VALUES (%d,'%s','%s')";
- $sql = sprintf(
- $sql,
- $id,
- $conv->escape($uri),
- $conv->escape(common_sql_now())
- );
- $conv->query($sql);
- }
- // This is something we should only have to do once unless introducing new, bad code.
- if (DEBUG) {
- printfnq(sprintf('Storing in config that we have done %s', __METHOD__));
- }
- common_config_set('fix', 'upgrade_initConversation', 1);
- printfnq("DONE.\n");
- }
- function fixupConversationURIs()
- {
- printfnq("Ensuring all conversations have a URI...");
- $conv = new Conversation();
- $conv->whereAdd('uri IS NULL');
- if ($conv->find()) {
- $rounds = 0;
- while ($conv->fetch()) {
- $uri = common_local_url('conversation', ['id' => $conv->id]);
- $sql = sprintf(
- <<<'END'
- UPDATE conversation
- SET uri = %1$s, modified = CURRENT_TIMESTAMP
- WHERE id = %2$d;
- END,
- $conv->_quote($uri),
- $conv->id
- );
- $conv->query($sql);
- if (($conv->N-++$rounds) % 500 == 0) {
- printfnq(sprintf(' %d items left...', $conv->N-$rounds));
- }
- }
- }
- printfnq("DONE.\n");
- }
- function initGroupProfileId()
- {
- printfnq("Ensuring all User_group entries have a Profile and profile_id...");
- $group = new User_group();
- $group->whereAdd('NOT EXISTS (SELECT id FROM profile WHERE id = user_group.profile_id)');
- $group->find();
- while ($group->fetch()) {
- try {
- // We must create a new, incrementally assigned profile_id
- $profile = new Profile();
- $profile->nickname = $group->nickname;
- $profile->fullname = $group->fullname;
- $profile->profileurl = $group->mainpage;
- $profile->homepage = $group->homepage;
- $profile->bio = $group->description;
- $profile->location = $group->location;
- $profile->created = $group->created;
- $profile->modified = $group->modified;
- $profile->query('START TRANSACTION');
- $id = $profile->insert();
- if (empty($id)) {
- $profile->query('ROLLBACK');
- throw new Exception('Profile insertion failed, profileurl: '.$profile->profileurl);
- }
- $group->query(sprintf(
- <<<'END'
- UPDATE user_group
- SET profile_id = %1$d, modified = CURRENT_TIMESTAMP
- WHERE id = %2$d
- END,
- $id,
- $group->getID()
- ));
- $profile->query('COMMIT');
- $profile->free();
- } catch (Exception $e) {
- printfv("Error initializing Profile for group {$group->nickname}:" . $e->getMessage());
- }
- }
- printfnq("DONE.\n");
- }
- function initLocalGroup()
- {
- printfnq("Ensuring all local user groups have a local_group...");
- $group = new User_group();
- $group->whereAdd('NOT EXISTS (select group_id from local_group where group_id = user_group.id)');
- $group->find();
- while ($group->fetch()) {
- try {
- // Hack to check for local groups
- if ($group->getUri() == common_local_url('groupbyid', ['id' => $group->id])) {
- $lg = new Local_group();
- $lg->group_id = $group->id;
- $lg->nickname = $group->nickname;
- $lg->created = $group->created; // XXX: common_sql_now() ?
- $lg->modified = $group->modified;
- $lg->insert();
- }
- } catch (Exception $e) {
- printfv("Error initializing local group for {$group->nickname}:" . $e->getMessage());
- }
- }
- printfnq("DONE.\n");
- }
- function initNoticeReshare()
- {
- if (common_config('fix', 'upgrade_initNoticeReshare') <= 1) {
- printfnq(sprintf("Skipping %s, fixed by previous upgrade.\n", __METHOD__));
- return;
- }
- printfnq("Ensuring all reshares have the correct verb and object-type...");
- $notice = new Notice();
- $notice->whereAdd('repeat_of IS NOT NULL');
- $notice->whereAdd(sprintf(
- '(verb <> %1$s OR object_type <> %2$s)',
- $notice->_quote(ActivityVerb::SHARE),
- $notice->_quote(ActivityObject::ACTIVITY)
- ));
- if ($notice->find()) {
- while ($notice->fetch()) {
- try {
- $orig = Notice::getKV('id', $notice->id);
- $notice->verb = ActivityVerb::SHARE;
- $notice->object_type = ActivityObject::ACTIVITY;
- $notice->update($orig);
- } catch (Exception $e) {
- printfv("Error updating verb and object_type for {$notice->id}:" . $e->getMessage());
- }
- }
- }
- // This is something we should only have to do once unless introducing new, bad code.
- if (DEBUG) {
- printfnq(sprintf('Storing in config that we have done %s', __METHOD__));
- }
- common_config_set('fix', 'upgrade_initNoticeReshare', 1);
- printfnq("DONE.\n");
- }
- function initSubscriptionURI()
- {
- printfnq("Ensuring all subscriptions have a URI...");
- $sub = new Subscription();
- $sub->whereAdd('uri IS NULL');
- if ($sub->find()) {
- while ($sub->fetch()) {
- try {
- $uri = Subscription::newUri(
- $sub->getSubscriber(),
- $sub->getSubscribed(),
- $sub->created
- );
- $sub->decache();
- $sub->query(sprintf(
- <<<'END'
- UPDATE subscription
- SET uri = %1$s, modified = CURRENT_TIMESTAMP
- WHERE subscriber = %2$d AND subscribed = %3$d
- END,
- $sub->_quote($uri),
- $sub->subscriber,
- $sub->subscribed
- ));
- } catch (Exception $e) {
- common_log(LOG_ERR, 'Error updating subscription URI: ' . $e->getMessage());
- }
- }
- }
- printfnq("DONE.\n");
- }
- function initGroupMemberURI()
- {
- printfnq("Ensuring all group memberships have a URI...");
- $mem = new Group_member();
- $mem->whereAdd('uri IS NULL');
- if ($mem->find()) {
- while ($mem->fetch()) {
- try {
- $uri = Group_member::newUri(
- Profile::getByID($mem->profile_id),
- User_group::getByID($mem->group_id),
- $mem->created
- );
- $mem->decache();
- $mem->query(sprintf(
- <<<'END'
- UPDATE group_member
- SET uri = %s, modified = CURRENT_TIMESTAMP
- WHERE profile_id = %d AND group_id = %d
- END,
- $mem->_quote($uri),
- $mem->profile_id,
- $mem->group_id
- ));
- } catch (Exception $e) {
- common_log(LOG_ERR, "Error updated membership URI: " . $e->getMessage());
- }
- }
- }
- printfnq("DONE.\n");
- }
- function initProfileLists()
- {
- printfnq("Ensuring all profile tags have a corresponding list...");
- $ptag = new Profile_tag();
- $ptag->selectAdd();
- $ptag->selectAdd('tagger, tag, COUNT(*) AS tagged_count');
- $ptag->whereAdd('NOT EXISTS (SELECT tagger, tagged FROM profile_list '.
- 'WHERE profile_tag.tagger = profile_list.tagger '.
- 'AND profile_tag.tag = profile_list.tag)');
- $ptag->groupBy('tagger, tag');
- $ptag->orderBy('tagger, tag');
- if ($ptag->find()) {
- while ($ptag->fetch()) {
- $plist = new Profile_list();
- $plist->tagger = $ptag->tagger;
- $plist->tag = $ptag->tag;
- $plist->private = false;
- $plist->created = common_sql_now();
- $plist->modified = $plist->created;
- $plist->mainpage = common_local_url(
- 'showprofiletag',
- ['tagger' => $plist->getTagger()->nickname,
- 'tag' => $plist->tag]
- );
- ;
- $plist->tagged_count = $ptag->tagged_count;
- $plist->subscriber_count = 0;
- $plist->insert();
- $orig = clone($plist);
- // After insert since it uses auto-generated ID
- $plist->uri = common_local_url(
- 'profiletagbyid',
- ['id' => $plist->id,
- 'tagger_id' => $plist->tagger]
- );
- $plist->update($orig);
- }
- }
- printfnq("DONE.\n");
- }
- /*
- * Added as we now store interpretd width and height in File table.
- */
- function fixupFileGeometry()
- {
- printfnq("Ensuring width and height is set for supported local File objects...");
- $file = new File();
- $file->whereAdd('filename IS NOT NULL'); // local files
- $file->whereAdd('width IS NULL OR width = 0');
- if ($file->find()) {
- while ($file->fetch()) {
- if (DEBUG) {
- printfnq(sprintf('Found file without width: %s\n', _ve($file->getFilename())));
- }
- // Set file geometrical properties if available
- try {
- $image = ImageFile::fromFileObject($file);
- } catch (ServerException $e) {
- // We couldn't make out an image from the file.
- if (DEBUG) {
- printfnq(sprintf('Could not make an image out of the file.\n'));
- }
- continue;
- }
- $orig = clone($file);
- $file->width = $image->width;
- $file->height = $image->height;
- if (DEBUG) {
- printfnq(sprintf('Setting image file and with to %sx%s.\n', $file->width, $file->height));
- }
- $file->update($orig);
- // FIXME: Do this more automagically inside ImageFile or so.
- if ($image->getPath() != $file->getPath()) {
- if (DEBUG) {
- printfnq(sprintf('Deleting the temporarily stored ImageFile.\n'));
- }
- $image->unlink();
- }
- unset($image);
- }
- }
- printfnq("DONE.\n");
- }
- /*
- * File_thumbnail objects for local Files store their own filenames in the database.
- */
- function deleteLocalFileThumbnailsWithoutFilename()
- {
- printfnq("Removing all local File_thumbnail entries without filename property...");
- $file = new File();
- $file->whereAdd('filename IS NOT NULL'); // local files
- if ($file->find()) {
- // Looping through local File entries
- while ($file->fetch()) {
- $thumbs = new File_thumbnail();
- $thumbs->file_id = $file->id;
- $thumbs->whereAdd("filename IS NULL OR filename = ''");
- // Checking if there were any File_thumbnail entries without filename
- if (!$thumbs->find()) {
- continue;
- }
- // deleting incomplete entry to allow regeneration
- while ($thumbs->fetch()) {
- $thumbs->delete();
- }
- }
- }
- printfnq("DONE.\n");
- }
- /*
- * Delete File_thumbnail entries where the referenced file does not exist.
- */
- function deleteMissingLocalFileThumbnails()
- {
- printfnq("Removing all local File_thumbnail entries without existing files...");
- $thumbs = new File_thumbnail();
- $thumbs->whereAdd("filename IS NOT NULL AND filename <> ''");
- // Checking if there were any File_thumbnail entries without filename
- if ($thumbs->find()) {
- while ($thumbs->fetch()) {
- try {
- $thumbs->getPath();
- } catch (FileNotFoundException $e) {
- $thumbs->delete();
- }
- }
- }
- printfnq("DONE.\n");
- }
- /*
- * Files are now stored with their hash, so let's generate for previously uploaded files.
- */
- function setFilehashOnLocalFiles()
- {
- printfnq('Ensuring all local files have the filehash field set...');
- $file = new File();
- $file->whereAdd("filename IS NOT NULL AND filename <> ''"); // local files
- $file->whereAdd('filehash IS NULL', 'AND'); // without filehash value
- if ($file->find()) {
- while ($file->fetch()) {
- try {
- $orig = clone($file);
- $file->filehash = hash_file(File::FILEHASH_ALG, $file->getPath());
- $file->update($orig);
- } catch (FileNotFoundException $e) {
- echo "\n WARNING: file ID {$file->id} does not exist on path '{$e->path}'. If there is no file system error, run: php scripts/clean_file_table.php";
- }
- }
- }
- printfnq("DONE.\n");
- }
- function fixupFileThumbnailUrlhash()
- {
- printfnq("Setting urlhash for File_thumbnail entries: ");
- switch (common_config('db', 'type')) {
- case 'pgsql':
- $url_sha256 = 'encode(sha256(CAST("url" AS bytea)), \'hex\')';
- break;
- case 'mysql':
- $url_sha256 = 'sha2(`url`, 256)';
- break;
- default:
- throw new Exception('Unknown DB type selected.');
- }
- $thumb = new File_thumbnail();
- $thumb->query(sprintf(
- 'UPDATE %1$s ' .
- 'SET urlhash = %2$s, modified = CURRENT_TIMESTAMP ' .
- 'WHERE url IS NOT NULL ' . // find all entries with a url value
- "AND url <> '' " . // precaution against non-null empty strings
- 'AND urlhash IS NULL', // but don't touch those we've already calculated
- $thumb->escapedTableName(),
- $url_sha256
- ));
- printfnq("DONE.\n");
- }
- function migrateProfilePrefs()
- {
- printfnq("Finding and possibly migrating Profile_prefs entries: ");
- $prefs = []; // ['qvitter' => ['cover_photo'=>'profile_banner_url', ...], ...]
- Event::handle('GetProfilePrefsMigrations', [&$prefs]);
- foreach ($prefs as $namespace=>$mods) {
- echo "$namespace... ";
- assert(is_array($mods));
- $p = new Profile_prefs();
- $p->namespace = $namespace;
- // find all entries in all modified topics given in this namespace
- $p->whereAddIn('topic', array_keys($mods), $p->columnType('topic'));
- $p->find();
- while ($p->fetch()) {
- // for each entry, update 'topic' to the new key value
- $orig = clone($p);
- $p->topic = $mods[$p->topic];
- $p->updateWithKeys($orig);
- }
- }
- printfnq("DONE.\n");
- }
- main();
|