src/playlist_editor.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2008-2014 by Andrzej Rybczak                            *
   3  *   electricityispower@gmail.com                                          *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.              *
  19  ***************************************************************************/
  20
  21 #include <algorithm>
  22 #include <boost/bind.hpp>
  23 #include <boost/date_time/posix_time/posix_time.hpp>
  24 #include <cassert>
  25
  26 #include "charset.h"
  27 #include "display.h"
  28 #include "global.h"
  29 #include "helpers.h"
  30 #include "playlist.h"
  31 #include "playlist_editor.h"
  32 #include "mpdpp.h"
  33 #include "regex_filter.h"
  34 #include "status.h"
  35 #include "statusbar.h"
  36 #include "tag_editor.h"
  37 #include "utility/comparators.h"
  38 #include "title.h"
  39 #include "screen_switcher.h"
  40
  41 using Global::MainHeight;
  42 using Global::MainStartY;
  43
  44 PlaylistEditor *myPlaylistEditor;
  45
  46 namespace {
  47
  48 size_t LeftColumnStartX;
  49 size_t LeftColumnWidth;
  50 size_t RightColumnStartX;
  51 size_t RightColumnWidth;
  52
  53 std::string SongToString(const MPD::Song &s);
  54 bool PlaylistEntryMatcher(const boost::regex &rx, const std::string &playlist);
  55 bool SongEntryMatcher(const boost::regex &rx, const MPD::Song &s);
  56
  57 }
  58
  59 PlaylistEditor::PlaylistEditor()
  60 : m_timer(boost::posix_time::from_time_t(0))
  61 , m_window_timeout(Config.data_fetching_delay ? 250 : 500)
  62 , m_fetching_delay(boost::posix_time::milliseconds(Config.data_fetching_delay ? 250 : -1))
  63 {
  64         LeftColumnWidth = COLS/3-1;
  65         RightColumnStartX = LeftColumnWidth+1;
  66         RightColumnWidth = COLS-LeftColumnWidth-1;
  67
  68         Playlists = NC::Menu<std::string>(0, MainStartY, LeftColumnWidth, MainHeight, Config.titles_visibility ? "Playlists" : "", Config.main_color, NC::Border::None);
  69         Playlists.setHighlightColor(Config.active_column_color);
  70         Playlists.cyclicScrolling(Config.use_cyclic_scrolling);
  71         Playlists.centeredCursor(Config.centered_cursor);
  72         Playlists.setSelectedPrefix(Config.selected_item_prefix);
  73         Playlists.setSelectedSuffix(Config.selected_item_suffix);
  74         Playlists.setItemDisplayer([](NC::Menu<std::string> &menu) {
  75                 menu << Charset::utf8ToLocale(menu.drawn()->value());
  76         });
  77
  78         Content = NC::Menu<MPD::Song>(RightColumnStartX, MainStartY, RightColumnWidth, MainHeight, Config.titles_visibility ? "Playlist content" : "", Config.main_color, NC::Border::None);
  79         Content.setHighlightColor(Config.main_highlight_color);
  80         Content.cyclicScrolling(Config.use_cyclic_scrolling);
  81         Content.centeredCursor(Config.centered_cursor);
  82         Content.setSelectedPrefix(Config.selected_item_prefix);
  83         Content.setSelectedSuffix(Config.selected_item_suffix);
  84         switch (Config.playlist_editor_display_mode)
  85         {
  86                 case DisplayMode::Classic:
  87                         Content.setItemDisplayer(boost::bind(Display::Songs, _1, contentProxyList(), Config.song_list_format));
  88                         break;
  89                 case DisplayMode::Columns:
  90                         Content.setItemDisplayer(boost::bind(Display::SongsInColumns, _1, contentProxyList()));
  91                         break;
  92         }
  93
  94         w = &Playlists;
  95 }
  96
  97 void PlaylistEditor::resize()
  98 {
  99         size_t x_offset, width;
 100         getWindowResizeParams(x_offset, width);
 101
 102         LeftColumnStartX = x_offset;
 103         LeftColumnWidth = width/3-1;
 104         RightColumnStartX = LeftColumnStartX+LeftColumnWidth+1;
 105         RightColumnWidth = width-LeftColumnWidth-1;
 106
 107         Playlists.resize(LeftColumnWidth, MainHeight);
 108         Content.resize(RightColumnWidth, MainHeight);
 109
 110         Playlists.moveTo(LeftColumnStartX, MainStartY);
 111         Content.moveTo(RightColumnStartX, MainStartY);
 112
 113         hasToBeResized = 0;
 114 }
 115
 116 std::wstring PlaylistEditor::title()
 117 {
 118         return L"Playlist editor";
 119 }
 120
 121 void PlaylistEditor::refresh()
 122 {
 123         Playlists.display();
 124         drawSeparator(RightColumnStartX-1);
 125         Content.display();
 126 }
 127
 128 void PlaylistEditor::switchTo()
 129 {
 130         SwitchTo::execute(this);
 131         markSongsInPlaylist(contentProxyList());
 132         drawHeader();
 133         refresh();
 134 }
 135
 136 void PlaylistEditor::update()
 137 {
 138         if (Playlists.reallyEmpty() || m_playlists_update_requested)
 139         {
 140                 m_playlists_update_requested = false;
 141                 Playlists.clearSearchResults();
 142                 withUnfilteredMenuReapplyFilter(Playlists, [this]() {
 143                         size_t idx = 0;
 144                         Mpd.GetPlaylists([this, &idx](std::string playlist) {
 145                                 if (idx < Playlists.size())
 146                                         Playlists[idx].value() = playlist;
 147                                 else
 148                                         Playlists.addItem(playlist);
 149                                 ++idx;
 150                         });
 151                         if (idx < Playlists.size())
 152                                 Playlists.resizeList(idx);
 153                         std::sort(Playlists.beginV(), Playlists.endV(),
 154                                 LocaleBasedSorting(std::locale(), Config.ignore_leading_the));
 155                 });
 156                 Playlists.refresh();
 157         }
 158
 159         if ((Content.reallyEmpty() && Global::Timer - m_timer > m_fetching_delay)
 160         ||  m_content_update_requested)
 161         {
 162                 m_content_update_requested = false;
 163                 if (Playlists.empty())
 164                         Content.clear();
 165                 else
 166                 {
 167                         Content.clearSearchResults();
 168                         withUnfilteredMenuReapplyFilter(Content, [this]() {
 169                                 size_t idx = 0;
 170                                 Mpd.GetPlaylistContent(Playlists.current().value(), [this, &idx](MPD::Song s) {
 171                                         if (idx < Content.size())
 172                                         {
 173                                                 Content[idx].value() = s;
 174                                                 Content[idx].setBold(myPlaylist->checkForSong(s));
 175                                         }
 176                                         else
 177                                                 Content.addItem(s, myPlaylist->checkForSong(s));
 178                                         ++idx;
 179                                 });
 180                                 if (idx < Content.size())
 181                                         Content.resizeList(idx);
 182                                 std::string title;
 183                                 if (Config.titles_visibility)
 184                                 {
 185                                         title = "Playlist content";
 186                                         title += " (";
 187                                         title += boost::lexical_cast<std::string>(Content.size());
 188                                         title += " item";
 189                                         if (Content.size() == 1)
 190                                                 title += ")";
 191                                         else
 192                                                 title += "s)";
 193                                         title.resize(Content.getWidth());
 194                                 }
 195                                 Content.setTitle(title);
 196                         });
 197                 }
 198                 Content.display();
 199         }
 200
 201         if (isActiveWindow(Content) && Content.reallyEmpty())
 202         {
 203                 Content.setHighlightColor(Config.main_highlight_color);
 204                 Playlists.setHighlightColor(Config.active_column_color);
 205                 w = &Playlists;
 206         }
 207
 208         if (Playlists.empty() && Content.reallyEmpty())
 209         {
 210                 Content.Window::clear();
 211                 Content.Window::display();
 212         }
 213 }
 214
 215 int PlaylistEditor::windowTimeout()
 216 {
 217         if (Content.reallyEmpty())
 218                 return m_window_timeout;
 219         else
 220                 return Screen<WindowType>::windowTimeout();
 221 }
 222
 223 bool PlaylistEditor::isContentFiltered()
 224 {
 225         if (Content.isFiltered())
 226         {
 227                 Statusbar::print("Function currently unavailable due to filtered playlist content");
 228                 return true;
 229         }
 230         return false;
 231 }
 232
 233 ProxySongList PlaylistEditor::contentProxyList()
 234 {
 235         return ProxySongList(Content, [](NC::Menu<MPD::Song>::Item &item) {
 236                 return &item.value();
 237         });
 238 }
 239
 240 void PlaylistEditor::AddToPlaylist(bool add_n_play)
 241 {
 242         if (isActiveWindow(Playlists) && !Playlists.empty())
 243         {
 244                 MPD::SongList list;
 245                 Mpd.GetPlaylistContent(Playlists.current().value(), vectorMoveInserter(list));
 246                 bool success = addSongsToPlaylist(list.begin(), list.end(), add_n_play, -1);
 247                 Statusbar::printf("Playlist \"%1%\" loaded%2%",
 248                         Playlists.current().value(), withErrors(success)
 249                 );
 250         }
 251         else if (isActiveWindow(Content) && !Content.empty())
 252                 addSongToPlaylist(Content.current().value(), add_n_play);
 253
 254         if (!add_n_play)
 255                 w->scroll(NC::Scroll::Down);
 256 }
 257
 258 void PlaylistEditor::enterPressed()
 259 {
 260         AddToPlaylist(true);
 261 }
 262
 263 void PlaylistEditor::spacePressed()
 264 {
 265         if (Config.space_selects)
 266         {
 267                 if (isActiveWindow(Playlists))
 268                 {
 269                         if (!Playlists.empty())
 270                         {
 271                                 Playlists.current().setSelected(!Playlists.current().isSelected());
 272                                 Playlists.scroll(NC::Scroll::Down);
 273                         }
 274                 }
 275                 else if (isActiveWindow(Content))
 276                 {
 277                         if (!Content.empty())
 278                         {
 279                                 Content.current().setSelected(!Content.current().isSelected());
 280                                 Content.scroll(NC::Scroll::Down);
 281                         }
 282                 }
 283         }
 284         else
 285                 AddToPlaylist(false);
 286 }
 287
 288 void PlaylistEditor::mouseButtonPressed(MEVENT me)
 289 {
 290         if (!Playlists.empty() && Playlists.hasCoords(me.x, me.y))
 291         {
 292                 if (!isActiveWindow(Playlists))
 293                 {
 294                         if (previousColumnAvailable())
 295                                 previousColumn();
 296                         else
 297                                 return;
 298                 }
 299                 if (size_t(me.y) < Playlists.size() && (me.bstate & (BUTTON1_PRESSED | BUTTON3_PRESSED)))
 300                 {
 301                         Playlists.Goto(me.y);
 302                         if (me.bstate & BUTTON3_PRESSED)
 303                         {
 304                                 size_t pos = Playlists.choice();
 305                                 spacePressed();
 306                                 if (pos < Playlists.size()-1)
 307                                         Playlists.scroll(NC::Scroll::Up);
 308                         }
 309                 }
 310                 else
 311                         Screen<WindowType>::mouseButtonPressed(me);
 312                 Content.clear();
 313         }
 314         else if (!Content.empty() && Content.hasCoords(me.x, me.y))
 315         {
 316                 if (!isActiveWindow(Content))
 317                 {
 318                         if (nextColumnAvailable())
 319                                 nextColumn();
 320                         else
 321                                 return;
 322                 }
 323                 if (size_t(me.y) < Content.size() && (me.bstate & (BUTTON1_PRESSED | BUTTON3_PRESSED)))
 324                 {
 325                         Content.Goto(me.y);
 326                         if (me.bstate & BUTTON1_PRESSED)
 327                         {
 328                                 size_t pos = Content.choice();
 329                                 spacePressed();
 330                                 if (pos < Content.size()-1)
 331                                         Content.scroll(NC::Scroll::Up);
 332                         }
 333                         else
 334                                 enterPressed();
 335                 }
 336                 else
 337                         Screen<WindowType>::mouseButtonPressed(me);
 338         }
 339 }
 340
 341 /***********************************************************************/
 342
 343 bool PlaylistEditor::allowsFiltering()
 344 {
 345         return true;
 346 }
 347
 348 std::string PlaylistEditor::currentFilter()
 349 {
 350         std::string filter;
 351         if (isActiveWindow(Playlists))
 352                 filter = RegexFilter<std::string>::currentFilter(Playlists);
 353         else if (isActiveWindow(Content))
 354                 filter = RegexFilter<MPD::Song>::currentFilter(Content);
 355         return filter;
 356 }
 357
 358 void PlaylistEditor::applyFilter(const std::string &filter)
 359 {
 360         if (filter.empty())
 361         {
 362                 if (isActiveWindow(Playlists))
 363                 {
 364                         Playlists.clearFilter();
 365                         Playlists.clearFilterResults();
 366                 }
 367                 else if (isActiveWindow(Content))
 368                 {
 369                         Content.clearFilter();
 370                         Content.clearFilterResults();
 371                 }
 372                 return;
 373         }
 374         try
 375         {
 376                 if (isActiveWindow(Playlists))
 377                 {
 378                         Playlists.showAll();
 379                         auto rx = RegexFilter<std::string>(
 380                                 boost::regex(filter, Config.regex_type), PlaylistEntryMatcher);
 381                         Playlists.filter(Playlists.begin(), Playlists.end(), rx);
 382                 }
 383                 else if (isActiveWindow(Content))
 384                 {
 385                         Content.showAll();
 386                         auto rx = RegexFilter<MPD::Song>(
 387                                 boost::regex(filter, Config.regex_type), SongEntryMatcher);
 388                         Content.filter(Content.begin(), Content.end(), rx);
 389                 }
 390         }
 391         catch (boost::bad_expression &) { }
 392 }
 393
 394 /***********************************************************************/
 395
 396 bool PlaylistEditor::allowsSearching()
 397 {
 398         return true;
 399 }
 400
 401 bool PlaylistEditor::search(const std::string &constraint)
 402 {
 403         if (constraint.empty())
 404         {
 405                 if (isActiveWindow(Playlists))
 406                         Playlists.clearSearchResults();
 407                 else if (isActiveWindow(Content))
 408                         Content.clearSearchResults();
 409                 return false;
 410         }
 411         try
 412         {
 413                 bool result = false;
 414                 if (isActiveWindow(Playlists))
 415                 {
 416                         auto rx = RegexFilter<std::string>(
 417                                 boost::regex(constraint, Config.regex_type), PlaylistEntryMatcher);
 418                         result = Playlists.search(Playlists.begin(), Playlists.end(), rx);
 419                 }
 420                 else if (isActiveWindow(Content))
 421                 {
 422                         auto rx = RegexFilter<MPD::Song>(
 423                                 boost::regex(constraint, Config.regex_type), SongEntryMatcher);
 424                         result = Content.search(Content.begin(), Content.end(), rx);
 425                 }
 426                 return result;
 427         }
 428         catch (boost::bad_expression &)
 429         {
 430                 return false;
 431         }
 432 }
 433
 434 void PlaylistEditor::nextFound(bool wrap)
 435 {
 436         if (isActiveWindow(Playlists))
 437                 Playlists.nextFound(wrap);
 438         else if (isActiveWindow(Content))
 439                 Content.nextFound(wrap);
 440 }
 441
 442 void PlaylistEditor::prevFound(bool wrap)
 443 {
 444         if (isActiveWindow(Playlists))
 445                 Playlists.prevFound(wrap);
 446         else if (isActiveWindow(Content))
 447                 Content.prevFound(wrap);
 448 }
 449
 450 /***********************************************************************/
 451
 452 ProxySongList PlaylistEditor::proxySongList()
 453 {
 454         auto ptr = ProxySongList();
 455         if (isActiveWindow(Content))
 456                 ptr = contentProxyList();
 457         return ptr;
 458 }
 459
 460 bool PlaylistEditor::allowsSelection()
 461 {
 462         return true;
 463 }
 464
 465 void PlaylistEditor::reverseSelection()
 466 {
 467         if (isActiveWindow(Playlists))
 468                 reverseSelectionHelper(Playlists.begin(), Playlists.end());
 469         else if (isActiveWindow(Content))
 470                 reverseSelectionHelper(Content.begin(), Content.end());
 471 }
 472
 473 MPD::SongList PlaylistEditor::getSelectedSongs()
 474 {
 475         MPD::SongList result;
 476         if (isActiveWindow(Playlists))
 477         {
 478                 bool any_selected = false;
 479                 for (auto &e : Playlists)
 480                 {
 481                         if (e.isSelected())
 482                         {
 483                                 any_selected = true;
 484                                 Mpd.GetPlaylistContent(e.value(), vectorMoveInserter(result));
 485                         }
 486                 }
 487                 // if no item is selected, add songs from right column
 488                 if (!any_selected && !Playlists.empty())
 489                         Mpd.GetPlaylistContent(Playlists.current().value(), vectorMoveInserter(result));
 490         }
 491         else if (isActiveWindow(Content))
 492         {
 493                 for (auto &e : Content)
 494                         if (e.isSelected())
 495                                 result.push_back(e.value());
 496                 // if no item is selected, add current one
 497                 if (result.empty() && !Content.empty())
 498                         result.push_back(Content.current().value());
 499         }
 500         return result;
 501 }
 502
 503 /***********************************************************************/
 504
 505 bool PlaylistEditor::previousColumnAvailable()
 506 {
 507         if (isActiveWindow(Content))
 508         {
 509                 if (!Playlists.reallyEmpty())
 510                         return true;
 511         }
 512         return false;
 513 }
 514
 515 void PlaylistEditor::previousColumn()
 516 {
 517         if (isActiveWindow(Content))
 518         {
 519                 Content.setHighlightColor(Config.main_highlight_color);
 520                 w->refresh();
 521                 w = &Playlists;
 522                 Playlists.setHighlightColor(Config.active_column_color);
 523         }
 524 }
 525
 526 bool PlaylistEditor::nextColumnAvailable()
 527 {
 528         if (isActiveWindow(Playlists))
 529         {
 530                 if (!Content.reallyEmpty())
 531                         return true;
 532         }
 533         return false;
 534 }
 535
 536 void PlaylistEditor::nextColumn()
 537 {
 538         if (isActiveWindow(Playlists))
 539         {
 540                 Playlists.setHighlightColor(Config.main_highlight_color);
 541                 w->refresh();
 542                 w = &Content;
 543                 Content.setHighlightColor(Config.active_column_color);
 544         }
 545 }
 546
 547 /***********************************************************************/
 548
 549 void PlaylistEditor::updateTimer()
 550 {
 551         m_timer = Global::Timer;
 552 }
 553
 554 void PlaylistEditor::Locate(const std::string &name)
 555 {
 556         update();
 557         for (size_t i = 0; i < Playlists.size(); ++i)
 558         {
 559                 if (name == Playlists[i].value())
 560                 {
 561                         Playlists.highlight(i);
 562                         Content.clear();
 563                         break;
 564                 }
 565         }
 566         switchTo();
 567 }
 568
 569 namespace {//
 570
 571 std::string SongToString(const MPD::Song &s)
 572 {
 573         std::string result;
 574         switch (Config.playlist_display_mode)
 575         {
 576                 case DisplayMode::Classic:
 577                         result = s.toString(Config.song_list_format_dollar_free, Config.tags_separator);
 578                         break;
 579                 case DisplayMode::Columns:
 580                         result = s.toString(Config.song_in_columns_to_string_format, Config.tags_separator);
 581                         break;
 582         }
 583         return result;
 584 }
 585
 586 bool PlaylistEntryMatcher(const boost::regex &rx, const std::string &playlist)
 587 {
 588         return boost::regex_search(playlist, rx);
 589 }
 590
 591 bool SongEntryMatcher(const boost::regex &rx, const MPD::Song &s)
 592 {
 593         return boost::regex_search(SongToString(s), rx);
 594 }
 595
 596 }