mirror of
https://github.com/wallabag/wallabag.git
synced 2024-12-23 08:06:33 +00:00
add cli export
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
parent
afaee1cc0a
commit
8303b037fb
3 changed files with 147 additions and 0 deletions
82
src/Wallabag/CoreBundle/Command/ExportCommand.php
Normal file
82
src/Wallabag/CoreBundle/Command/ExportCommand.php
Normal file
|
@ -0,0 +1,82 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Wallabag\CoreBundle\Command;
|
||||||
|
|
||||||
|
use Doctrine\ORM\NoResultException;
|
||||||
|
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
|
||||||
|
use Symfony\Component\Console\Input\InputArgument;
|
||||||
|
use Symfony\Component\Console\Input\InputInterface;
|
||||||
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
|
use Symfony\Component\Console\Output\StreamOutput;
|
||||||
|
|
||||||
|
class ExportCommand extends ContainerAwareCommand
|
||||||
|
{
|
||||||
|
protected function configure()
|
||||||
|
{
|
||||||
|
$this
|
||||||
|
->setName('wallabag:export')
|
||||||
|
->setDescription('Export all entries for an user')
|
||||||
|
->setHelp('This command helps you to export all entries for an user')
|
||||||
|
->addArgument(
|
||||||
|
'username',
|
||||||
|
InputArgument::REQUIRED,
|
||||||
|
'User from which to export entries'
|
||||||
|
)
|
||||||
|
->addArgument(
|
||||||
|
'filename',
|
||||||
|
InputArgument::OPTIONAL,
|
||||||
|
'Path of the exported file'
|
||||||
|
)
|
||||||
|
;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function execute(InputInterface $input, OutputInterface $output)
|
||||||
|
{
|
||||||
|
try {
|
||||||
|
$user = $this->getUser($input->getArgument('username'));
|
||||||
|
} catch (NoResultException $e) {
|
||||||
|
$output->writeln(sprintf('<error>User "%s" not found.</error>', $input->getArgument('username')));
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
$entries = $this->getDoctrine()
|
||||||
|
->getRepository('WallabagCoreBundle:Entry')
|
||||||
|
->getBuilderForAllByUser($user->getId())
|
||||||
|
->getQuery()
|
||||||
|
->getResult();
|
||||||
|
|
||||||
|
$output->write(sprintf('Exporting %d entrie(s) for user « <comment>%s</comment> »... ', count($entries), $user->getUserName()));
|
||||||
|
|
||||||
|
$filePath = $input->getArgument('filename');
|
||||||
|
if (!$filePath) {
|
||||||
|
$filePath = $this->getContainer()->getParameter('kernel.root_dir') . '/../' . sprintf('%s-export', $user->getUsername());
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
$data = $this->getContainer()->get('wallabag_core.helper.entries_export')
|
||||||
|
->setEntries($entries)
|
||||||
|
->updateTitle('All')
|
||||||
|
->exportJsonData();
|
||||||
|
file_put_contents($filePath, $data);
|
||||||
|
} catch (\InvalidArgumentException $e) {
|
||||||
|
$output->writeln(sprintf('<error>Error: "%s"</error>', $e->getMessage()));
|
||||||
|
}
|
||||||
|
|
||||||
|
$output->writeln('<info>Done.</info>');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetches a user from its username.
|
||||||
|
*
|
||||||
|
* @param string $username
|
||||||
|
*
|
||||||
|
* @return \Wallabag\UserBundle\Entity\User
|
||||||
|
*/
|
||||||
|
private function getUser($username)
|
||||||
|
{
|
||||||
|
return $this->getDoctrine()->getRepository('WallabagUserBundle:User')->findOneByUserName($username);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function getDoctrine()
|
||||||
|
{
|
||||||
|
return $this->getContainer()->get('doctrine');
|
||||||
|
}
|
||||||
|
}
|
|
@ -89,6 +89,11 @@ class EntriesExport
|
||||||
throw new \InvalidArgumentException(sprintf('The format "%s" is not yet supported.', $format));
|
throw new \InvalidArgumentException(sprintf('The format "%s" is not yet supported.', $format));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function exportJsonData()
|
||||||
|
{
|
||||||
|
return $this->prepareSerializingContent('json');
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Use PHPePub to dump a .epub file.
|
* Use PHPePub to dump a .epub file.
|
||||||
*
|
*
|
||||||
|
|
60
tests/Wallabag/CoreBundle/Command/ExportCommandTest.php
Normal file
60
tests/Wallabag/CoreBundle/Command/ExportCommandTest.php
Normal file
|
@ -0,0 +1,60 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Tests\Wallabag\CoreBundle\Command;
|
||||||
|
|
||||||
|
use Symfony\Bundle\FrameworkBundle\Console\Application;
|
||||||
|
use Symfony\Component\Console\Tester\CommandTester;
|
||||||
|
use Wallabag\CoreBundle\Command\ExportCommand;
|
||||||
|
use Tests\Wallabag\CoreBundle\WallabagCoreTestCase;
|
||||||
|
|
||||||
|
class ExportCommandTest extends WallabagCoreTestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @expectedException Symfony\Component\Console\Exception\RuntimeException
|
||||||
|
* @expectedExceptionMessage Not enough arguments (missing: "username")
|
||||||
|
*/
|
||||||
|
public function testExportCommandWithoutUsername()
|
||||||
|
{
|
||||||
|
$application = new Application($this->getClient()->getKernel());
|
||||||
|
$application->add(new ExportCommand());
|
||||||
|
|
||||||
|
$command = $application->find('wallabag:export');
|
||||||
|
|
||||||
|
$tester = new CommandTester($command);
|
||||||
|
$tester->execute([
|
||||||
|
'command' => $command->getName(),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testExportCommandWithBadUsername()
|
||||||
|
{
|
||||||
|
$application = new Application($this->getClient()->getKernel());
|
||||||
|
$application->add(new ExportCommand());
|
||||||
|
|
||||||
|
$command = $application->find('wallabag:export');
|
||||||
|
|
||||||
|
$tester = new CommandTester($command);
|
||||||
|
$tester->execute([
|
||||||
|
'command' => $command->getName(),
|
||||||
|
'username' => 'unknown',
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertContains('User "unknown" not found', $tester->getDisplay());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testExportCommand()
|
||||||
|
{
|
||||||
|
$application = new Application($this->getClient()->getKernel());
|
||||||
|
$application->add(new ExportCommand());
|
||||||
|
|
||||||
|
$command = $application->find('wallabag:export');
|
||||||
|
|
||||||
|
$tester = new CommandTester($command);
|
||||||
|
$tester->execute([
|
||||||
|
'command' => $command->getName(),
|
||||||
|
'username' => 'admin',
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertContains('Exporting 6 entrie(s) for user « admin »... Done', $tester->getDisplay());
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in a new issue