aboutsummaryrefslogtreecommitdiff
path: root/backend/tol_data/enwiki/gen_img_data.py
blob: 2c243f3d9b706c08dabb0b380e6a3a80c38117ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
#!/usr/bin/python3

"""
For some set of page IDs, looks up their content in the wiki dump,
and tries to parse infobox image names, storing them into a database.

The program can be re-run with an updated set of page IDs, and
will skip already-processed page IDs.
"""

import argparse
import re
import os
import bz2
import html
import urllib.parse
import sqlite3

DUMP_FILE = 'enwiki-20220501-pages-articles-multistream.xml.bz2'
INDEX_DB = 'dump_index.db'
IMG_DB = 'img_data.db' # The database to create
DB_FILE = os.path.join('..', 'data.db')

ID_LINE_REGEX = re.compile(r'<id>(.*)</id>')
IMG_LINE_REGEX = re.compile(r'.*\| *image *= *([^|]*)')
BRACKET_IMG_REGEX = re.compile(r'\[\[(File:[^|]*).*]]')
IMG_NAME_REGEX = re.compile(r'.*\.(jpg|jpeg|png|gif|tiff|tif)', flags=re.IGNORECASE)
CSS_IMG_CROP_REGEX = re.compile(r'{{css image crop\|image *= *(.*)', flags=re.IGNORECASE)

# ========== For data generation ==========

def genData(pageIds: set[int], dumpFile: str, indexDb: str, imgDb: str) -> None:
	print('Opening databases')
	indexDbCon = sqlite3.connect(indexDb)
	indexDbCur = indexDbCon.cursor()
	imgDbCon = sqlite3.connect(imgDb)
	imgDbCur = imgDbCon.cursor()

	print('Checking tables')
	if imgDbCur.execute('SELECT name FROM sqlite_master WHERE type="table" AND name="page_imgs"').fetchone() is None:
		# Create tables if not present
		imgDbCur.execute('CREATE TABLE page_imgs (page_id INT PRIMARY KEY, img_name TEXT)')
			# 'img_name' values are set to NULL to indicate page IDs where no image was found
		imgDbCur.execute('CREATE INDEX page_imgs_idx ON page_imgs(img_name)')
	else:
		# Check for already-processed page IDs
		numSkipped = 0
		for (pid,) in imgDbCur.execute('SELECT page_id FROM page_imgs'):
			if pid in pageIds:
				pageIds.remove(pid)
				numSkipped += 1
			else:
				print(f'Found already-processed page ID {pid} which was not in input set')
		print(f'Will skip {numSkipped} already-processed page IDs')

	print('Getting dump-file offsets')
	offsetToPageids: dict[int, list[int]] = {}
	offsetToEnd: dict[int, int] = {} # Maps chunk-start offsets to their chunk-end offsets
	iterNum = 0
	for pageId in pageIds:
		iterNum += 1
		if iterNum % 1e4 == 0:
			print(f'At iteration {iterNum}')

		query = 'SELECT offset, next_offset FROM offsets WHERE id = ?'
		row: tuple[int, int] | None = indexDbCur.execute(query, (pageId,)).fetchone()
		if row is None:
			print(f'WARNING: Page ID {pageId} not found')
			continue
		chunkOffset, endOffset = row
		offsetToEnd[chunkOffset] = endOffset
		if chunkOffset not in offsetToPageids:
			offsetToPageids[chunkOffset] = []
		offsetToPageids[chunkOffset].append(pageId)
	print(f'Found {len(offsetToEnd)} chunks to check')

	print('Iterating through chunks in dump file')
	with open(dumpFile, mode='rb') as file:
		iterNum = 0
		for pageOffset, endOffset in offsetToEnd.items():
			iterNum += 1
			if iterNum % 100 == 0:
				print(f'At iteration {iterNum}')

			chunkPageIds = offsetToPageids[pageOffset]
			# Jump to chunk
			file.seek(pageOffset)
			compressedData = file.read(None if endOffset == -1 else endOffset - pageOffset)
			data = bz2.BZ2Decompressor().decompress(compressedData).decode()
			# Look in chunk for pages
			lines = data.splitlines()
			lineIdx = 0
			while lineIdx < len(lines):
				# Look for <page>
				if lines[lineIdx].lstrip() != '<page>':
					lineIdx += 1
					continue
				# Check page id
				lineIdx += 3
				idLine = lines[lineIdx].lstrip()
				match = ID_LINE_REGEX.fullmatch(idLine)
				if match is None or int(match.group(1)) not in chunkPageIds:
					lineIdx += 1
					continue
				pageId = int(match.group(1))
				lineIdx += 1
				# Look for <text> in <page>
				foundText = False
				while lineIdx < len(lines):
					if not lines[lineIdx].lstrip().startswith('<text '):
						lineIdx += 1
						continue
					foundText = True
					# Get text content
					content: list[str] = []
					line = lines[lineIdx]
					content.append(line[line.find('>') + 1:])
					lineIdx += 1
					foundTextEnd = False
					while lineIdx < len(lines):
						line = lines[lineIdx]
						if not line.endswith('</text>'):
							content.append(line)
							lineIdx += 1
							continue
						foundTextEnd = True
						content.append(line[:line.rfind('</text>')])
						# Look for image-filename
						imageName = getImageName(content)
						imgDbCur.execute('INSERT into page_imgs VALUES (?, ?)', (pageId, imageName))
						break
					if not foundTextEnd:
						print(f'WARNING: Did not find </text> for page id {pageId}')
					break
				if not foundText:
					print(f'WARNING: Did not find <text> for page id {pageId}')

	print('Closing databases')
	indexDbCon.close()
	imgDbCon.commit()
	imgDbCon.close()

def getImageName(content: list[str]) -> str | None:
	""" Given an array of text-content lines, tries to return an infoxbox image name, or None """
	# Note: Doesn't try and find images in outside-infobox [[File:...]] and <imagemap> sections
	for line in content:
		match = IMG_LINE_REGEX.match(line)
		if match is not None:
			imageName = match.group(1).strip()
			if imageName == '':
				return None
			imageName = html.unescape(imageName)
			# Account for {{...
			if imageName.startswith('{'):
				match = CSS_IMG_CROP_REGEX.match(imageName)
				if match is None:
					return None
				imageName = match.group(1)
			# Account for [[File:...|...]]
			if imageName.startswith('['):
				match = BRACKET_IMG_REGEX.match(imageName)
				if match is None:
					return None
				imageName = match.group(1)
			# Account for <!--
			if imageName.find('<!--') != -1:
				return None
			# Remove an initial 'File:'
			if imageName.startswith('File:'):
				imageName = imageName[5:]
			# Remove an initial 'Image:'
			if imageName.startswith('Image:'):
				imageName = imageName[6:]
			# Check for extension
			match = IMG_NAME_REGEX.match(imageName)
			if match is not None:
				imageName = match.group(0)
				imageName = urllib.parse.unquote(imageName)
				imageName = html.unescape(imageName) # Intentionally unescaping again (handles some odd cases)
				imageName = imageName.replace('_', ' ')
				return imageName
			# Exclude lines like: | image = &lt;imagemap&gt;
			return None
	return None

# ========== For getting input page IDs ==========

def getInputPageIdsFromDb(dbFile: str) -> set[int]:
	print('Getting input page-ids')
	pageIds: set[int] = set()
	dbCon = sqlite3.connect(dbFile)
	dbCur = dbCon.cursor()
	for (pageId,) in dbCur.execute('SELECT id from wiki_ids'):
		pageIds.add(pageId)
	dbCon.close()

	print(f'Found {len(pageIds)}')
	return pageIds

# ========== Main block ==========

if __name__ == '__main__':
	parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
	parser.parse_args()

	pageIds = getInputPageIdsFromDb(DB_FILE)
	genData(pageIds, DUMP_FILE, INDEX_DB, IMG_DB)