ExtractFace Documentation

Using ExtractFace

  1. Start Mozilla Firefox;
  2. Start MozRepl addon if you didn't set the Activate on startup option;
    • When using ExtractFace, be sure that MozRepl is started.
    • You can check the Activate on startup option so it will start automatically when you use Firefox.
    • MozRepl is listening for connections on the default port 4242. Be sure that you don't have a firewall that blocks the connection.
  3. Login to your profile;
  4. Go to your target profile;
  5. Right-click on ExtractFace taskbar icon to popup the menu.
Menu Menu Remove
Menu Messenger

Scroll and Expand

Facebook, like many other websites, use Javascript/Ajax to display content to the user. The page is the same but the content change as user click on things or do something. Often, to be able to see the whole page, you have to scroll and click lot of things which could be very time consuming if you want it all.

To automate that process, ExtractFace provides the Scroll and the Expand function. Both would work on many pages of a Facebook profile like the Timeline page or a page with photo and comments. Here are some more explanations about these functions:

  • Scroll: This function will scroll down the page until the end, except if you set a maximum of pages to scroll or a maximum date. See Settings.
  • Expand: This function will click on See more and other similar links. The Expand function can be customized. See Settings for details.
  • Scroll and Expand: This function alternates between the Scroll and the Expand function so it scrolls one time, expands, scrolls again, expands, and so on...

These functions don't check if you are on the right page. So you have to choose it manually. To use these function on a page with photo and comments, you must open the page in normal view, not a popup window. To do this:

  • Right click on the photo and select Open Link in New Tab
  • If it opens a popup, close it.

Remove

Menu Remove

Many Facebook pages have a scrollable area that you can scroll to get the full content, but when you try to print it, the result is probably not what you want. So instead of extracting all those scrollable areas, ExtractFace allows you to remove fixed sections like top (blue bar and profile header), left column, right column, bottom or all at once.

Another thing you may to remove to reduce the size of the timeline is comments.

Note that these functions only affect the local copy of the page you are seeing in your browser. You can get back to the original at anything time by refreshing the page.

Top of the page

Current Profile ID

CurrentPID

When you select this function, ExtractFace will parse the current profile in Firefox to gather the profile ID.

Dump Albums

This function can be use to gather all (or selected) albums of photos. It works with any type of profile that may contain albums like people, page and group profiles.

DumpAlbumsWindow

When you select this function, ExtractFace:

  1. Displays the Dump albums window (as shown above)
  2. Checks if you are in the right page:
    • If you are not in the right page: If you selected Load and scroll automatically in Settings, ExtractFace will load it for you. Otherwise, it will display an error message.
  3. When you are in the right page, ExtractFace determine the profile type, get the username (or the userid) to propose in the filename. Then, it load the available albums.

Available options are:

  • Report format: You have three choices: XLSX, HTML and TXT (TSV). Default is HTML. XLSX and TXT (TSV) are good choices if you only want the URLs or the number of albums is too big to be displayed on a single page.
  • Open album folder: At the end of the process, the folder where the album have been saved will be opened in Window Explorer.
  • Small pictures: Download the small picture (the one in the album page). This one is fast because the image is loaded in cache when the album is loaded in Firefox.
  • Large pictures: To get the large image, ExtractFace must open the page of each picture and wait for the image to load.
  • Videos: Download the video, if this is a video album.
  • Include publication date: If you select this option, ExtractFace will gather the date that the photo or video has been published.

ExtractFace will create a directory for each album selected and download all the images from that album. The HTML report contain all albums with the small pictures. You can click on any small picture to get the large picture. You must know that if you don't download the pictures, they will be displayed in the HTML report, but as links.

Top of the page

Dump Friends

This function can be use to gather all friend lists (or selected) of a profile. It produces a report that contains details of profile's friends.

DumpFriendsWindow

When you select this function, ExtractFace:

  1. Displays the Dump friends window (as shown above)
  2. Checks if you are in the right page:
    • If you are not in the right page: If you selected Load and scroll automatically in Settings, ExtractFace will load it for you. Otherwise, it will display an error message.
  3. When you are in the right page, ExtractFace get the username (or the userid) to propose in the filename. Then, it load the available friend lists.

Available options are:

  • Report format: You have three choices: XLSX, HTML and TXT (TSV). Default is XLSX (see sample below). HTML is a good choice if you want to print the profiles. Note that XLSX format could crash ExtractFace if too much images have to be inserted in a workbook.
  • Include profile icons: Image of profiles are included in the report. For HTML format, profile icon are always included, but if you check this option, images will be save locally instead of links. If you have problems, you can use HTML format without checking this option. Then, when you open the report with Firefox, you can use "Save as" in Firefox to save profile icon locally. You'll have to do this for each page. The option is not available for TXT format.

The XLSX report will look like this:

DumpFriendsSample

Top of the page

Dump Mutual Friends

This function can be used to get the friends from a mutual friends page. The report is similar to Dump Friends.

DumpMutualFriendsWindow

Available options are:

  • Report format: You have three choices: XLSX, HTML and TXT (TSV). Default is XLSX. HTML is a good choice if you want to print the profiles. Note that XLSX format could crash ExtractFace if too much images have to be inserted in a workbook.
  • Include profile icons: Image of profiles are included in the report. For HTML format, profile icon are always included, but if you check this option, images will be save locally instead of links. If you have problems, you can use HTML format without checking this option. Then, when you open the report with Firefox, you can use "Save as" in Firefox to save profile icon locally. You'll have to do this for each page. The option is not available for TXT format.
  • Autoscroll: You can scroll the page manually before using this function or you can select this option. If you do it, the page will be scrolled at the moment of the dump. This is particularly important if you use the Queue.
Top of the page

Dump Contributors

This function can be used to list all persons that contribute to a particular page. Like Scroll and Expand functions, this one can be used on any page that contains comments and/or Likes. This function can also be used to list all persons that post on a page (Visitor posts, you must be in the right page which should contains posts_to_page in the url) or Event Posts. These two options are only enabled and available when you are on the right page. For people profile, ExtractFace can browse picture pages and gather all contributors.

DumpContribWindow

This function produce the same kind of report than Dump Friends, but there is an additional column, that contains the number of times a contributor is found. It can be used to determine who are the biggest contributor to a particular page. Types of contributors are:

  • Comments: All person that post a comment on the page. It includes replies. As comments are all on the main page, this one is the fastest.
  • Likes: Any types of Likes. This one should be the slowest, because ExtractFace has to open a page for every group of Likes.
  • Visitor Posts: You can find Visitors Posts on the left-hand side of some page profile. The Visitor Posts open in a popup window.
  • Event Posts: Posts that you can found on a Event page.

Available options are:

  • Report format: You have three choices: XLSX, HTML and TXT (TSV). Default is XLSX. HTML is a good choice if you want to print the profiles.
  • Include profile icons: Image of profiles are included in the report. For HTML format, profile icon are always included, but if you check this option, images will be save locally instead of links.
  • Scroll and Expand: If you select this option, the page will be scrolled and expanded. To select the part of the page manually, you can use Scroll and Expand function before using Dump contributors and uncheck this option. Note also that Likes pages are always scrolled when dumping.

When you click on Picture pages option, ExtractFace load the album page of the profile to gather the album names and urls.

Top of the page

Dump Comments

This function can be used dump all comments posted on a particular page. It can also be used to dump all For people profile, ExtractFace can browse picture pages and gather comments on those pages too.

DumpCommentsWindow

Available options are:

  • Report format: You have three choices: XLSX, HTML and TXT (TSV). Default is HTML.
  • Include Images: This includes image of profiles, but also images inside each comment. For HTML format, images are always included, but if you check this option, they will be save locally instead of links.
  • Scroll and Expand: If you select this option, the page will be scrolled and expanded. To select the part of the page manually, you can use Scroll and Expand function before using Dump comments and uncheck this option.

When you click on Picture pages option, ExtractFace load the album page of the profile to gather the album names and urls.

Top of the page

Dump Event Members

This function can be use to gather the guest lists associated to an event. The report is similar to Dump Friends.

DumpEventsWindow

When you select this function, ExtractFace:

  1. Displays the Dump event members window (as shown above)
  2. Checks if you are in the events page.
  3. If not, displays an error message.
  4. If yes, gathers details about the guest lists. There are four guest lists for each event:
    • Going (or went);
    • Maybe;
    • Invited;
    • Declined (Can't Go);
  5. The proposed filename include the event id.

Available options are:

  • Report format: You have three choices: XLSX, HTML and TXT (TSV). Default is XLSX. HTML is a good choice if you want to print the profiles.
  • Include profile icons: Image of profiles are included in the report. For HTML format, profile icon are always included, but if you check this option, images will be save locally instead of links. The option is not available for TXT format.

Important: For each guest list, you will get a maximum of 500 members.

Top of the page

Dump Group Members

This function can be used to list all the members of a group. The report is similar to Dump Friends.

DumpGMWindow

When you select this function, ExtractFace:

  1. Displays the Dump Group Members window (as shown above)
  2. Checks if you are in the right page:
    • If you are not in the right page: If you selected Load and scroll automatically in Settings, ExtractFace will load it for you. Otherwise, it will display an error message.
  3. When you are in the right page, ExtractFace get the username (or the userid) to propose in the filename. Then, it load the available lists. For public group, these lists should be Admins and Members. For closed group, Admins and Members are grouped in the same page.

Available options are:

  • Report format: You have three choices: XLSX, HTML and TXT (TSV). Default is XLSX. HTML is a good choice if you want to print the profiles. Note that XLSX format could crash ExtractFace if too much images have to be inserted in a workbook.
  • Include profile icons: Image of profiles are included in the report. For HTML format, profile icon are always included, but if you check this option, images will be save locally instead of links. If you have problems, you can use HTML format without checking this option. Then, when you open the report with Firefox, you can use "Save as" in Firefox to save profile icon locally. You'll have to do this for each page. The option is not available for TXT format.

Messenger Functions

ExtractFace provides some functions to help you extract conversations from your Facebook profile. To be able to use these functions, you must select View All in Messenger from the Facebook menu.

Menu

Scroll Contacts

The Scroll Contacts function will scroll the list of contacts on the left-hand side of the window until it reach the bottom of the list.

Dump Contacts

This function can be used to dump all the contact list.

DumpContactsWindow

Available options are:

  • Report format: You have three choices: XLSX, HTML and TXT (TSV). Default is XLSX. HTML is a good choice if you want to print the profiles.
  • Include profile icons: Image of profiles are included in the report. For HTML format, profile icon are always included, but if you check this option, images will be save locally instead of links. If you have problems, you can use HTML format without checking this option. Then, when you open the report with Firefox, you can use "Save as" in Firefox to save profile icon locally. You'll have to do this for each page. The option is not available for TXT format.
  • Autoscroll: You can scroll the page manually before using this function or you can select this option. If you do it, the page will be scrolled at the moment of the dump. This is particularly important if you use the Queue.
Top of the page

Scroll Chat

The Scroll Chat function will scroll until it reaches the beginning of the conversation, except if you set a maximum of pages to scroll or a maximum date. See Settings about that.

Load older/newer messages

If you only want a part of the conversation, you can also do a search by using the Search messages in the conversation function provided by Facebook. When you find the message, you can use Load Older Messages and/or Load Newer Messages functions in ExtractFace to show older or newer messages around the searched one.

Dump Chat

This function can be used to dump a single or multiples conversations.

DumpChatWindow

When you select this function, ExtractFace:

  1. Displays the Dump Chat window (as shown above)
  2. Checks if you are in the right page:
    • If you are not in the right page: If you selected Load and scroll automatically in Settings, ExtractFace will load it for you. Otherwise, it will display an error message.
  3. Propose a filename that include your username (or userid) and the username (or userid) of the main interlocutor.

This function has several options:

  • Report format: You have three choices: XLSX, HTML and TXT (TSV). Default is HTML (see sample below).
  • Autoscroll: You can scroll the chat manually before using this function or you can select this option. If you do it, the page will be scrolled at the moment of the dump. This is particularly important if you use the Queue.
  • Include: If you select the HTML report format, all these objects will be included as links, but if you select them, they will be saved locally.
    • Images: This is related to small image like profile icons and all Facebook images like emoticons and emoji.
    • Pictures: Pictures are images that have been included in the chat by the users.
    • Attached document: This can be any file that was attached to a message in a chat.
    • Videos: ExtractFace will insert the video in the output HTML file.
    • Vocal messages: This object is particular, because ExtractFace have to open Mobile Facebook to get the files. If the number of downloaded files is not exactly the same as the number of vocal messages spotted in the conversation, ExtractFace will put all the vocal messages on a second page linked to the conversation. Otherwise, each vocal message will be inserted in the conversation at the right place. Note that if you don't select this option, even the HTML report will contain only a notice about the presence of a vocal message (with the duration of it). Also notice that vocal messages are not available for archived conversations.
  • Dates: Here you can select a date range to be dumped. See note below about dates.
  • Current Chat: The current conversation will be dumped.
  • Select Chats: If you select this option, ExtractFace will list all the available conversations. If you selected Load and scroll automatically in Settings, the contact list will be scrolled and all the conversations in your profiles will be gathered. If not, only conversations from shown contacts will be gathered. Note that with this option, Dump Now is not avaialable, because all selected conversations will be added to Queue as invidual process. Selected options will be the same for all conversations.

Directories that could be created by ExtractFace (if needed):

  • images_[page title]: For the image files
  • videos_[page title]: For the video files
  • docs_[page title]: For attached documents
  • vm_[page title]: For vocal messages

Note about date: With the new Messenger interface, the parsing of dates will only work if your profile language is set to English US.

The output HTML file should look like this:

DumpChatSample

Dumping huge conversation

If you have to dump a huge conversation (thousand of messages) and you can't display it all in Firefox because regular scrolling get stuck before reaching the beginning of the conversation. There is a solution:

  1. Use regular scrolling and dump the most recent messages;
  2. Until you reach the begining of the conversation:
    1. Use the Search messages in the conversation function in Facebook to search the older message displayed in the part you already dumped;
    2. Use the Load Older Messages function in ExtractFace. To prevent crash Firefox, you could set a limit to the scrolling (See Settings about that);
    3. Dump the displayed part;
    4. Reload the page in Firefox before doing another search;

Note that you should not use this solution with Queue.

Top of the page

Open Current Chat - Mobile Facebook

When you are in Messenger, using this function will open the current conversation in Mobile Facebook.

Dump Vocal Messages - Mobile Facebook

This function can be used to dump vocal messages from Mobile Facebook. It can be used if Dump Chat failed or if you only want to dump vocal messages.

DumpVocalMessagesWindow

There is no special settings or options for this function.

Top of the page

Queue

The queue is a new concept introduced in the version 6.0 of the program. It allows you to batch multiple dump processes and start them all at the same time.

When you use a dump function, ExtractFace build a database that contains all the selected parameters and start a new ExtractFace process that is independant from the main program. This new process loads the database and executes the dumping process while the main program is waiting (to prevent that more than one process run at the same time).

When you click the Add to queue button instead of the Dump Now button, the database is still created, but the process is not started. Instead, it is queued.

QueueWindow

All databases are stored in a Queue subfolder in the user directory. The Queue window (as shown above) contain the filename of the database ([DumpFonction]-[Unixtime]), the filename for the report and the starting url associated to the dump process.

You can delete any of the process from the queue by right clicking on it and selecting the appropriate function. The Go to page function (from the context menu) open the starting url in Firefox.

While a process is running, the database associated with it is updated to indicates the current status of the process and the data that has been collected so far. If the process crashes, it can be restarted manually by restarting the main program.

When ExtractFace starts, it look for any pending job in the queue. This can be a job that hasn't been started yet, or a job that crashed. Whatever reason, ExtractFace will ask you to load or delete all the remaining database in queue.

Top of the page

Settings

There are a few parameters that can be set in ExtractFace.

General options

SettingsWindow

In Tool section, we have the following functions and options:

  • Export Lang.ini: Use this function to translate ExtractFace GUI. See Translation for help about this functionality.
  • Check Update: Check on le-tools.com if a tool update is available.
  • Check for update at startup: When ExtractFace starts, check on website for available update of the tool.

In Functions section, you have:

  • Dynamic menu: With this option, ExtractFace will determine the profile type of the current page before showing the menu, so only the available functions will be enabled. Note that there is a short waiting time before displaying the menu when this option is turned on.
  • Remember position of all windows: By default, every windows are centered in your main screen. If you use multiple monitor, it can be useful to have ExtractFace on the same screen as Firefox. Use this option to remember the position of any window. Position is saved when the window is closed.
  • Time for loading: Time to wait when a page (or new content) must be loaded in Firefox. Default value is 2 seconds. As ExtractFace must often gather content from internet, it can be affected by network latency. When ExtractFace tries to access data in Firefox too fast, it may crash the process or
  • Charset: ExtractFace supports UTF8 (used on Facebook) internally, but the interface (Win32-GUI) doesn't support it. So, in some cases (ex.: Friends categories, album names, etc.), it may be a problem. Sometime, the charset will depend on the language of your profile and sometime, it will depend on the language of the target profile. To deal with that, ExtractFace supports different charsets. Default is cp1252.
  • Logging: Logging can be useful for troubleshooting. When enabled, all errors are stored in a file in the user directory.


Scroll and Expand options

SettingsWindow2

The following options are related to the available scrolling and expanding functions within ExtractFace.

  • Maximum scrolling (chat): When you use scroll chat functions (there are three), ExtractFace scrolls up or down, waits for the additional content to display, scrolls again, and so on until it reaches the beginning or the end of the conversation. By page is the maximum of times ExtractFace will scroll (not the number of messages displayed). Default value is 0 which means no limit. If you set a date using By date option, ExtractFace will stop scrolling when the given date will be visible in the conversation, but it doesn't mean it will stop exactly to this date. Be also aware that, if you set a date here, it won't be saved after ExtractFace will be closed as it will for the maximum set using By page.
  • Maximum scrolling (other): Like the previous option, but it is associated to the general Scroll function.
  • Expand options: These options are related to the Expand function and the combined Scroll and Expand function. Every option allows to expand a particular type of content: additional text (See more button or link), comments or posts.


Dump options

SettingsWindow3

These options are related to the dump functions.

  • When loading:
    • Load and scroll automatically: If you check this option, ExtractFace will automatically load the page associated with the dump function you called. For example, if you selected Dump Albums, the page that contains all albums will be opened, as long as the page exists. Then, ExtractFace will scroll the page if necessary, like for Dump Contacts. Disable this option if you want to select the page manually or want to dump only a part of a page.
    • Scroll back to top when loaded: When a page is fully loaded (using automatic scrolling), it will scroll back to top.
    • Remember folder used for report: In each dump window, you must select a directory where the report and downloaded files will be saved. If you select this option, the report will be automatically saved.
  • When processing:
    • Silent progression when using queue: When you are using Queue, it usually means you want to do something else while the process running. If you select this option, the progress window will start minimized and there will be no popup about error or success. You should use Logging, if you want to keep information about errors. You should also check Disable opening when using queue (see below).
  • When finished:
    • Open report: The report is opened with the default program (associated with the extension of the report format) when the dumping process is finished.
    • Disable opening when using queue: If you started a Queue with many tasks in it, it could be a problem to see files be constantly opened.
    • Close used tabs: For some dump functions, ExtractFace must open new tabs in Firefox, but sometimes, these tabs are not closed. If you are using a Queue, it could become a problem if too many tabs get opened. If you select this option, ExtractFace remembers the number of opened tabs when the dumping process begins and it closes any additionnal tab still opened when the process finishes.
    • Delete temp files when finished: When ExtractFace saves data, it uses a temp directory, usually in the same directory as the report. If this option is checked, the temp directory is deleted when function ends.
Top of the page

 

Credits to Free Website Templates for the template of this Website